Registration¶

An analysis enters the catalogue by registration. Registration is currently done together with the platform team; a self-service path is being designed. This page describes what to send, what we do with it, and what changes afterwards.

flowchart LR
    B[Build the image] --> C[Check it with yousleep-verify]
    C --> S[Send it to us]
    S --> R[We check it the same way,<br/>measure its memory, pin the digest, register it]
    R --> A[It appears in your<br/>organisation's catalogue]

What to send¶

A project started with yousleep-init has everything below in place after make record.

The image, as a reference we can pull or as a docker save archive.
The configuration file, the one yousleep-verify passed with.
The expected document, conformance/expected-events.json.gz, recorded with --record on your final image.
The check's report, yousleep-verify --json, so that we can compare it with our run. Its run line reports the peak memory the container used: set base_system_memory_mib so that the peak is at most about 77% of it, which leaves 30% headroom. If you measured memory against recording length with yousleep-verify --meter --propose, send that output too.

Send it through the portal's contact form under Integrate an algorithm, or to contact@yousleep.ai. Do not include real recordings: the check runs on a synthetic one on both sides.

What we do¶

Run the same check on the platform's architecture (linux/amd64). An image that fails there is not registered.
Pin the digest the check reports, so the exact bytes that passed are what runs.
Copy the image into a registry the platform controls. A past analysis has to stay re-runnable, and that cannot depend on a registry we do not operate.
Set the fields that are ours: scheduling and the memory terms that scale with recording length. We measure those with yousleep-verify --meter on synthetic recordings of up to 48 hours at 128 to 512 Hz. When the declared terms leave less than 30% headroom at any point, we set the terms it proposes.
Register the configuration. Its provenance and licence blocks are shown to users as written, so they are checked for completeness, not rewritten.

After registration¶

Your analysis is offered first to the organisation it is registered for. Its members find it in the catalogue with its provenance, what it cites and the licence it is offered under, and every result it produces carries that attribution.

An analysis developed outside youSleep is offered to every user only once its developer's signed Analysis Declaration is on record: a form stating what the analysis is, what data it was developed on and under which terms, and how to credit it. We send it for signature. The licence class in the configuration sets the terms on which the analysis may be run.

What changes later¶

The check you run and the check we run are the same tool. What is being designed is the path between them: submitting the bundle above from the portal, a quarantine where an image waits until the check has passed, and registration without a person in the loop.