-
Notifications
You must be signed in to change notification settings - Fork 128
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.
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
Adding a docker image for the toolkit #1071
base: main
Are you sure you want to change the base?
Conversation
@Ziaeemehr, I've added an mvp on how the image can be automatically built upon new releases. What's left is the actual |
container images are available and auto-built w/ GitHub Actions, so you can use w/ Docker
to build and run locally: $ docker build -t sbi .
$ docker run -v $(pwd)/examples:/sbi -p 8888:8888 -ti sbi
|
I have to admit that I am new to using docker. Can you say in simple terms how I would make use of this new feature? |
Wouldn't a |
Docker is a platform that enables developers to build, ship, and run applications in containers. Containers are lightweight, standalone, and executable packages that contain everything needed to run an application, including the code, runtime, libraries, and dependencies. It's kind of making an conda environment but user does not need to be worry about installing packages and dependencies. For me installing Cuda toolkit always be annoying and sometimes with headache, especially when you have parallel package which need different version of cuda. It can also be used for developement, quick introduction video. @turnmanh know more about the Github Action and Github Registry. As far as I understand, it build the image and uploads it to a hub as a new version of the package release. Maintenance is likely minimal and it uses the same version you maintain for pip. |
What does this implement/fix? Explain your changes
In order to ease the usability of the toolkit, a Docker image is provided to the user. It allows to:
The image is based on the newest release and a re-built is triggered by a new release of the toolkit. The image is published via ghcr.
Does this close any currently open issues?
Fixes #1056
Any relevant code examples, logs, error output, etc?
todo: add how to use the image.
Checklist
Put an
x
in the boxes that apply. You can also fill these out after creatingthe PR. If you're unsure about any of them, don't hesitate to ask. We're here to
help! This is simply a reminder of what we are going to look for before merging
your code.
guidelines
with
pytest.mark.slow
.guidelines
main
(or there are no conflicts withmain
)