Guides
Releasing outputs
What to check first, the Release outputs dialog, what is saved with a release, who can see it, what to do when it fails, and releasing a corrected version.
App in development
On this page
The portal screens are in development. Their words and layout may still change; the commands behind the buttons are already built.
To share results, you release them. A release never changes, and you share it with its share link. IDs, paths and numbers here are examples.
Before you release
- The output files are under
~/project/outputs. - The reproduce script,
~/project/reproduce.sh, holds the commands that rebuild the outputs from scratch. If Claude wrote it, open it and check. - Random seeds are fixed.
The Release outputs dialog
On the workspace, press [Release outputs]. You can also press [Release outputs] on the [Releases] screen and pick the workspace under “Choose the workspace to release from.”
- Workspace
ws-0012- Who can see
- 2 of 31 people
Only the people who can see this workspace's results can see the released outputs.
project/outputs/model.pt project/outputs/roc_curve.png Give paths relative to the work folder. A folder releases every file in it. project/reproduce.sh The file with the commands that make the outputs again. For now Synapse only checks that it exists; it does not run it. Runs when pressed
release create --workspace ws-0012 --outputs project/outputs/model.pt project/outputs/roc_curve.png --reproduce project/reproduce.sh - Who can see. The people who will be able to see this release: “Only the people who can see this workspace's results can see the released outputs.”
- Files to release. Paths relative to the work folder: the IDE's
~/project/outputsfolder isproject/outputs. A folder releases every file in it. [Add a file] adds a field. - Reproduce command. The file with the commands that make the outputs again, such as
project/reproduce.sh. - Replaces (optional). If this redoes an earlier release, choose it.
- Command to run. The command the dialog will run, updated as you type.
Press [Release outputs]: the dialog shows “Releasing” and the console shows the progress. When it finishes you see “Released: r-0139”, and “Just released” offers [Open] and [Copy share link].
release create --workspace ws-0012 --outputs project/outputs/model.pt project/outputs/roc_curve.png --reproduce project/reproduce.sh ... Recording the input data... Saving the work folder and environment... Working out who can see it... Registering the outputsReleased: r-0139Who can see this release: 2 of 31 people. Admins can always see.Condition: ehr_full and one of ct_research or imaging_all What is saved with a release
A release keeps what was there at that moment. Source data is not copied; its state at that moment is kept.
- The work folder: code, intermediate files, checkpoints, the Python packages you installed and your Claude conversations.
- The environment: the environment as it was, system packages included.
- The data: exactly the data the workspace could see.
- The reproduce script.
- The released files, each with its size and SHA-256.
The share page says “The reproduce command and the environment at the time are saved.” If the workspace never started, it says the environment was not saved.
Saved work folders and environments are visible to the workspace owner and to admins only. People who may see the release still cannot see the work folder.
To save the work folder and the environment at the same instant, the workspace pauses for a moment during the release and then carries on.
Today a release checks only that the reproduce script exists; it does not run it, so every release shows “Not re-run yet”. Running it again to verify is planned.
Who can see it
A release is visible only to people who may see all the data its workspace has used. Admins can always see it.
When permissions on the source data change, the system works it out again. Someone whose access is revoked can no longer open the share link, and someone who gains access can. When a result is safe to share more widely, such as aggregate statistics, an admin can widen that one release, with a reason.
Through Claude or a workspace terminal
Inside a workspace, a release can only be requested. Ask Claude and it makes the request and gives you an approval link. In a workspace terminal:
In a workspace terminal
synapse ws request release --outputs project/outputs/model.pt project/outputs/roc_curve.png --reproduce project/reproduce.sh Output (example)
Requested approval: a-0034Outputs: project/outputs/model.pt, project/outputs/roc_curve.png (2 files)Who can see this release: 2 of 31 people. Admins can always see.It runs after the researcher approves it in the portal: https://app.example.org/approve/a-0034 It runs once you approve it under Approvals. If the files change after the request, approving does not run it; request again after changing them.
If it does not work
The screen says what failed in one sentence, and the reason names the path. Output files are checked when you request and again before releasing, so you find out at once.
| What the screen says | What to do |
|---|---|
| A path is not in the work folder. | Paths are relative to the work folder (~): ~/project/outputs/model.pt is project/outputs/model.pt. |
| A path is a symbolic link. | Replace it with the real file, then try again. |
| A path is not a regular file. | Only regular files and folders can be released. |
| A folder is empty. | Leave the empty folder out, or put files in it. |
| A file name is not valid UTF-8. | Rename it, then try again. |
| It is over the size limit. | For too many files, zip the folder and release the zip file. |
| The workspace is archived: ws-0012 | Restore it, then release. |
Releasing a corrected version
A release cannot be edited. Release the corrected or redone result as a new release and choose the earlier one under “Replaces (optional)”; the earlier release's page then points to the new one. On the [Releases] screen you can also choose the earlier release and press [Release new version].
release create --workspace ws-0012 --outputs project/outputs/model.pt --reproduce project/reproduce.sh --supersedes r-0139