Skip to content

Commit f6eab4c

Browse files
authored
Update readme to remove mentions of docker image publication (#22)
* update readme to remove docker image publication * continue cleaning
1 parent 01905f6 commit f6eab4c

1 file changed

Lines changed: 5 additions & 10 deletions

File tree

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -97,15 +97,10 @@ Each model can be experimented using a python environment dedicated to the proje
9797

9898
#### Docker Container
9999

100-
The AI4SIM GitHub CI/CD publishes in the [GitHub registry](https://github.com/AI4SIM/model-collection/pkgs/container/model-collection) a docker image dedicated to each model project proposed in the **Model collection** repository. Each image is built on a public **Ubuntu** base image (e.g. *nvidia/cuda:11.7.1-cudnn8-runtime-ubuntu20.04*). The model project code has been added in ``/home/ai4sim/<domain>/<use-case>/<NN architecture>`` and its requirements have been installed in the container.
100+
It is possible to build a docker image dedicated to each model project proposed in the **Model collection** repository. You can find the instructions in the [Contribute](#contribute) section of this README, to build your own docker.
101101

102-
Each image can be identified using its docker tag, ``<domain>-<use-case>-<NN architecture>``, that is automatically built from the model project path ``<domain>/<use-case>/<NN architecture>``. For example, you can pull the docker images for the ``weather-forecast/ecrad-3d-correction/unets`` model project using:
103-
104-
```bash
105-
docker pull ghcr.io/ai4sim/model-collection:weather-forecast-ecrad-3d-correction-unets
106-
```
107-
108-
If you want to experiment with the model in a different environment you can build your own docker image following the instructions described in [Contribute](#contribute).
102+
Each image is built on a public **Ubuntu** base image (e.g. *nvidia/cuda:11.7.1-cudnn8-runtime-ubuntu20.04*), and tagged using the ``<domain>-<use-case>-<NN architecture>`` format, that is automatically built from the model project path ``<domain>/<use-case>/<NN architecture>``
103+
Once built, you can find in the container the model project code at ``/home/ai4sim/<domain>/<use-case>/<NN architecture>``.
109104

110105
#### Virtual Environment
111106

@@ -166,7 +161,7 @@ cd <domain>/<use-case>/<NN architecture>
166161
podman run \
167162
-v ./data:/home/ai4sim/<domain>/<use-case>/<NN architecture>/data \
168163
-w /home/ai4sim/<domain>/<use-case>/<NN architecture> \
169-
ghcr.io/ai4sim/model-collection:<domain>-<use-case>-<NN architecture> \
164+
model-collection:<domain>-<use-case>-<NN architecture> \
170165
uv run trainer.py --config configs/<training-config>.yaml
171166
```
172167

@@ -520,7 +515,7 @@ Then commit this last change.
520515

521516
The CI/CD workflows are defined by the GitHub Actions Yaml files in the ``workflows`` folder. There are 2 different workflows:
522517
- the *code quality* CI/CD workflow: this workflow (see ``workflows/ai4sim-ci-cd.yaml``) is in charge of running tests and lint for all model projects, to detect possible regressions. It is triggered by any change done on any branch and on any pull requests.
523-
- the *docker image builder* CI/CD workflow: this workflow (see ``workflows/images-ci-cd.yaml``) is in charge of building and publishing the docker images for all model projects. It is triggered by any change done on the *main* branch and on any pull requests targeting the *main* branch.
518+
- the *docker image builder* CI/CD workflow: this workflow (see ``workflows/images-ci-cd.yaml``) is in charge of testing the build of the docker images for all model projects. It is triggered by any change done on the *main* branch and on any pull requests targeting the *main* branch.
524519

525520
The CI/CD workflows run the same actions for all model projects listed in the *jobs/strategy/matrix/model-project* section of the Yaml files.
526521

0 commit comments

Comments
 (0)