From 3becffa0d7f47750536b702c9f252420e7e5d5a0 Mon Sep 17 00:00:00 2001 From: Sam Ritchie Date: Mon, 22 Jan 2024 15:28:12 -0500 Subject: [PATCH] get it --- README.md | 8 ++++---- docs/cloud/ai_platform_tpu.rst | 2 +- docs/explore/base_image.rst | 12 ++++++------ docs/index.rst | 4 ++-- setup.cfg | 33 --------------------------------- 5 files changed, 13 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 511faf6..e47f2c6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Caliban -[![Build status](https://github.com/google/caliban/workflows/build/badge.svg?branch=master)](https://github.com/google/caliban/actions?query=workflow%3Abuild+branch%3Amaster) -[![Codecov branch](https://img.shields.io/codecov/c/github/google/caliban/master.svg?maxAge=3600)](https://codecov.io/github/google/caliban) +[![Build status](https://github.com/google/caliban/workflows/build/badge.svg?branch=main)](https://github.com/google/caliban/actions?query=workflow%3Abuild+branch%3Amain) +[![Codecov branch](https://img.shields.io/codecov/c/github/google/caliban/main.svg?maxAge=3600)](https://codecov.io/github/google/caliban/tree/main) [![JOSS](https://joss.theoj.org/papers/c33c8b464103b2fb3b641878722bf8f3/status.svg)](https://joss.theoj.org/papers/c33c8b464103b2fb3b641878722bf8f3) [![readthedocs](https://img.shields.io/readthedocs/caliban?maxAge=3600)](https://caliban.readthedocs.io/en/latest/?badge=latest) [![caliban version](https://img.shields.io/pypi/v/caliban?maxAge=3600)](https://pypi.org/project/caliban) @@ -178,12 +178,12 @@ will: ### Preparing your Project Create an empty directory and use `curl` to download a [python -script](https://github.com/google/caliban/blob/master/tutorials/basic/mnist.py#L16) +script](https://github.com/google/caliban/blob/main/tutorials/basic/mnist.py#L16) that trains a basic neural network. ``` mkdir demo && cd demo -curl --output mnist.py https://raw.githubusercontent.com/google/caliban/master/tutorials/basic/mnist.py +curl --output mnist.py https://raw.githubusercontent.com/google/caliban/main/tutorials/basic/mnist.py ``` Create a file called `requirements.txt` to declare `tensorflow-cpu` as a dependency: diff --git a/docs/cloud/ai_platform_tpu.rst b/docs/cloud/ai_platform_tpu.rst index 217fa1f..969d239 100644 --- a/docs/cloud/ai_platform_tpu.rst +++ b/docs/cloud/ai_platform_tpu.rst @@ -4,7 +4,7 @@ TPUs on AI Platform .. NOTE:: This documentation is currently quite sparse; expect a tutorial soon. .. IMPORTANT:: Unlike on Cloud, TPUs on AI Platform only support (as of - Dec 2019) Tensorflow versions 1.13 and 1.14. No Jax, no Pytorch. + Dec 2019) Tensorflow versions 1.13 and 1.14. No JAX, no Pytorch. Caliban has Tensorflow version 2.1 hardcoded internally. Once the range of possible values expands we'll make this customizable. diff --git a/docs/explore/base_image.rst b/docs/explore/base_image.rst index e19c2ad..831b2fc 100644 --- a/docs/explore/base_image.rst +++ b/docs/explore/base_image.rst @@ -53,14 +53,14 @@ you can build and use your own specialized image. The dockerfiles we use to generate our supported images can be found `here `_. We create -base gpu images from the `Dockerfile.gpu `_ +base gpu images from the `Dockerfile.gpu `_ file, and then use these as base images for creating full GPU images with -support for specific python versions using this `Dockerfile `_. +support for specific python versions using this `Dockerfile `_. We base our gpu base images on the `nvidia/cuda `_ images, which contain the relevant CUDA drivers required for GPU use. The virtual environment inside of the Caliban container isolates you from these low-level details, -so you can install any tensorflow version you like, or use Jax or Pytorch or any +so you can install any tensorflow version you like, or use JAX or Pytorch or any other system. Details for Maintainers @@ -69,11 +69,11 @@ Details for Maintainers We utilize Google's `Cloud Build `_ service to build Caliban's base images. Our Cloud Build configuration file that controls our image generation can be found in the source repository -`here `_. +`here `_. This file can quickly get lengthy and difficult to maintain, so we generate this file -using `a script `_ -and `a configuration file `_. +using `a script `_ +and `a configuration file `_. In the configuration file, we specify our supported CUDA versions, our supported python versions, and a list of the combinations we use in our supported images. For our CUDA and python versions, we specify a list of build-args that we then diff --git a/docs/index.rst b/docs/index.rst index 84f0f59..dfbb544 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -63,7 +63,7 @@ declare some set of dependencies in either a ``requirements.txt`` or The rest of this document contains detailed information and guides on Caliban's various modes. If you want to get started in a more interactive way, head over to `the Caliban tutorials -directory `_. +directory `_. Caliban's code lives on `Github `_. @@ -72,7 +72,7 @@ Using Caliban If you want to practice using Caliban with a proper getting-started style guide, head over to `Caliban's tutorials -`_ (Coming +`_ (Coming Soon!). See the sidebar for information on the subcommands exposed by Caliban and a diff --git a/setup.cfg b/setup.cfg index bed5e4d..72bc497 100644 --- a/setup.cfg +++ b/setup.cfg @@ -18,36 +18,3 @@ style = pep440 versionfile_source = caliban/_version.py versionfile_build = caliban/_version.py tag_prefix = - -[mypy-tqdm.*] -ignore_missing_imports = True - -[mypy-absl.*] -ignore_missing_imports = True - -[mypy-blessings.*] -ignore_missing_imports = True - -[mypy-googleapiclient.*] -ignore_missing_imports = True - -[mypy-sqlalchemy.*] -ignore_missing_imports = True - -[mypy-kubernetes.*] -ignore_missing_imports = True - -[mypy-google.*] -ignore_missing_imports = True - -[mypy-urllib3.*] -ignore_missing_imports = True - -[mypy-yaspin.*] -ignore_missing_imports = True - -[mypy-schema.*] -ignore_missing_imports = True - -[mypy-commentjson.*] -ignore_missing_imports = True