diff --git a/bitnami/jax/0/debian-11/Dockerfile b/bitnami/jax/0/debian-11/Dockerfile index ea7046ec85be0..362864fd813aa 100644 --- a/bitnami/jax/0/debian-11/Dockerfile +++ b/bitnami/jax/0/debian-11/Dockerfile @@ -6,10 +6,10 @@ FROM docker.io/bitnami/minideb:bullseye ARG TARGETARCH LABEL org.opencontainers.image.base.name="docker.io/bitnami/minideb:bullseye" \ - org.opencontainers.image.created="2023-07-12T15:42:54Z" \ + org.opencontainers.image.created="2023-07-13T15:51:53Z" \ org.opencontainers.image.description="Application packaged by VMware, Inc" \ org.opencontainers.image.licenses="Apache-2.0" \ - org.opencontainers.image.ref.name="0.4.13-debian-11-r0" \ + org.opencontainers.image.ref.name="0.4.13-debian-11-r1" \ org.opencontainers.image.title="jax" \ org.opencontainers.image.vendor="VMware, Inc." \ org.opencontainers.image.version="0.4.13" diff --git a/bitnami/jax/README.md b/bitnami/jax/README.md index e69de29bb2d1d..c5308e274633a 100644 --- a/bitnami/jax/README.md +++ b/bitnami/jax/README.md @@ -0,0 +1,162 @@ +# JAX packaged by Bitnami + +## What is JAX? + +> JAX is a Python-based toolset (Autograd and XLA) for high performance machine learning applications. Features familiar API, transformations and multiple backend support. + +[Overview of JAX](https://jax.readthedocs.io) +Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement. + +## TL;DR + +```console +docker run -it --name jax bitnami/jax +``` + +### Docker Compose + +```console +curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jax/docker-compose.yml > docker-compose.yml +docker-compose up -d +``` + +## Why use Bitnami Images? + +- Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems. +- With Bitnami images the latest bug fixes and features are available as soon as possible. +- Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs. +- All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution. +- All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DCT)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images. +- Bitnami container images are released on a regular basis with the latest distribution packages available. + +Looking to use JAX in production? Try [VMware Application Catalog](https://bitnami.com/enterprise), the enterprise edition of Bitnami Application Catalog. + +## Why use a non-root container? + +Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://docs.bitnami.com/tutorials/work-with-non-root-containers/). + +## Supported tags and respective `Dockerfile` links + +Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/). + +You can see the equivalence between the different tags by taking a look at the `tags-info.yaml` file present in the branch folder, i.e `bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml`. + +Subscribe to project updates by watching the [bitnami/containers GitHub repo](https://github.com/bitnami/containers). + +## Get this image + +The recommended way to get the Bitnami Jax Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jax). + +```console +docker pull bitnami/jax:latest +``` + +To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/jax/tags/) in the Docker Hub Registry. + +```console +docker pull bitnami/jax:[TAG] +``` + +If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the `docker build` command. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values. + +```console +git clone https://github.com/bitnami/containers.git +cd bitnami/APP/VERSION/OPERATING-SYSTEM +docker build -t bitnami/APP:latest . +``` + +## Entering the REPL + +By default, running this image will drop you into the Python REPL, where you can interactively test and try things out with JAX in Python. + +```console +docker run -it --name jax bitnami/jax +``` + +## Configuration + +### Running your JAX app + +The default work directory for the JAX image is `/app`. You can mount a folder from your host here that includes your JAX script, and run it normally using the `python` command. + +```console +docker run -it --name jax -v /path/to/app:/app bitnami/jax \ + python script.py +``` + +### Running a JAX app with package dependencies + +If your JAX app has a `requirements.txt` defining your app's dependencies, you can install the dependencies before running your app. + +```console +docker run -it --name jax -v /path/to/app:/app bitnami/jax \ + sh -c "pip install --file requirements.txt && python script.py" +``` + +**Further Reading:** + +- [jax documentation](https://jax.readthedocs.iodocs/) + +## Maintenance + +### Upgrade this image + +Bitnami provides up-to-date versions of JAX, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. + +#### Step 1: Get the updated image + +```console +docker pull bitnami/jax:latest +``` + +or if you're using Docker Compose, update the value of the image property to `bitnami/jax:latest`. + +#### Step 2: Remove the currently running container + +```console +docker rm -v jax +``` + +or using Docker Compose: + +```console +docker-compose rm -v jax +``` + +#### Step 3: Run the new image + +Re-create your container from the new image. + +```console +docker run --name jax bitnami/jax:latest +``` + +or using Docker Compose: + +```console +docker-compose up jax +``` + +## Contributing + +We'd love for you to contribute to this Docker image. You can request new features by creating an [issue](https://github.com/bitnami/containers/issues) or submitting a [pull request](https://github.com/bitnami/containers/pulls) with your contribution. + +## Issues + +If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template. + +## License + +Copyright © 2023 VMware, Inc. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License.