Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[fix] Add note about docker images to be pushed to Synapse #522

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[fix] Add note about docker images to be pushed to Synapse #522

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a283478
Add note about docker images to be pushed to Synapse
vpchung Jan 17, 2024
4dc1c2e
Merge branch 'main' into fix-mlcube-docs
vpchung Mar 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/mlcubes/mlcube_models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ docker_image_name [docker/image:latest]: # (6)!
5. Indicates how many GPUs should be visible by the MLCube.
6. MLCubes use Docker containers under the hood. Here, you can provide an image tag to the image that will be created by this MLCube. **You should use a valid name that allows you to upload it to a Docker registry.**

!!!Note If you are creating a MLCube to submit on the [Synapse.org platform](https://www.synapse.org/#), you must prefix the Docker image name with: `docker.synapse.org/<project synID>/`, where `<project synID>` is the ID of your Synapse project. For example, if your Synapse project ID is syn12345, then a potential `docker_image_name` could be: `docker.synapse.org/syn12345/my-model` or `docker.synapse.org/syn12345/brats2023`

After filling the configuration options, the following directory structure will be generated:

```bash
Expand Down
Loading