chore: udate README.md to include processing unit parameter.

superlinear-ai · Aug 23, 2023 · 8d70ad8 · 8d70ad8
1 parent 255bc59
commit 8d70ad8
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -62,6 +62,8 @@ To update your Python project with the latest template:
 | `author_name`                     <br> "John Smith"                                 | The full name of the primary author of the package.                                                                                                                                                                                                                                                                                                                                               |
 | `author_email`                    <br> "john@example.com"                           | The email address of the primary author of the package.                                                                                                                                                                                                                                                                                                                                           |
 | `python_version`                  <br> "3.8"                                        | The minimum Python version that the package requires.                                                                                                                                                                                                                                                                                                                                             |
+| `processing_unit`                  <br> ["CPU","GPU]                                        | The processing unit we want to use for our application. We support CUDA Toolkit 11.8 with python versions 3.8, 3.9, 3.10.                                                                                                                                                                                                                                                                                                                                            |
+
 | `development_environment`         <br> ["simple", "strict"]                         | Whether to configure the development environment with a focus on simplicity or with a focus on strictness. In strict mode, additional [Ruff rules](https://beta.ruff.rs/docs/rules/) are added, and tools such as [Mypy](https://github.com/python/mypy) and [Pytest](https://github.com/pytest-dev/pytest) are set to strict mode.                                                               |
 | `with_conventional_commits`       <br> ["0", "1"]                                   | If "1", [Commitizen](https://github.com/commitizen-tools/commitizen) will verify that your commits follow the [Conventional Commits](https://www.conventionalcommits.org/) standard. In return, `cz bump` may be used to automate [Semantic Versioning](https://semver.org/) and [Keep A Changelog](https://keepachangelog.com/).                                                                 |
 | `with_fastapi_api`                <br> ["0", "1"]                                   | If "1", [FastAPI](https://github.com/tiangolo/fastapi) is added as a run time dependency, FastAPI API stubs and tests are added, a `poe api` command for serving the API is added, and an `app` stage that packages the API is added to the Dockerfile. Additionally, the CI workflow will push the application as a Docker image instead of publishing the Python package.                       |