Skip to content

Commit

Permalink
get it
Browse files Browse the repository at this point in the history
  • Loading branch information
sritchie committed Jan 22, 2024
1 parent 6405e0e commit 3becffa
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 46 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/ai_platform_tpu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions docs/explore/base_image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/google/caliban/tree/master/dockerfiles>`_. We create
base gpu images from the `Dockerfile.gpu <https://github.com/google/caliban/blob/master/dockerfiles/Dockerfile.gpu>`_
base gpu images from the `Dockerfile.gpu <https://github.com/google/caliban/blob/main/dockerfiles/Dockerfile.gpu>`_
file, and then use these as base images for creating full GPU images with
support for specific python versions using this `Dockerfile <https://github.com/google/caliban/blob/master/dockerfiles/Dockerfile>`_.
support for specific python versions using this `Dockerfile <https://github.com/google/caliban/blob/main/dockerfiles/Dockerfile>`_.

We base our gpu base images on the `nvidia/cuda <https://hub.docker.com/r/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
Expand All @@ -69,11 +69,11 @@ Details for Maintainers
We utilize Google's `Cloud Build <http://cloud.google.com/cloud-build/docs>`_ 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 <https://github.com/google/caliban/blob/master/cloudbuild.json>`_.
`here <https://github.com/google/caliban/blob/main/cloudbuild.json>`_.

This file can quickly get lengthy and difficult to maintain, so we generate this file
using `a script <https://github.com/google/caliban/blob/master/scripts/cloudbuild.py>`_
and `a configuration file <https://github.com/google/caliban/blob/master/scripts/cloudbuild_config.json>`_.
using `a script <https://github.com/google/caliban/blob/main/scripts/cloudbuild.py>`_
and `a configuration file <https://github.com/google/caliban/blob/main/scripts/cloudbuild_config.json>`_.
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
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/google/caliban/blob/master/tutorials/README.md>`_.
directory <https://github.com/google/caliban/blob/main/tutorials/README.md>`_.

Caliban's code lives on `Github <https://github.com/google/caliban>`_.

Expand All @@ -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
<https://github.com/google/caliban/blob/master/tutorials/README.md>`_ (Coming
<https://github.com/google/caliban/blob/main/tutorials/README.md>`_ (Coming
Soon!).

See the sidebar for information on the subcommands exposed by Caliban and a
Expand Down
33 changes: 0 additions & 33 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 3becffa

Please sign in to comment.