From b4067ae4fa253cc7998ba3a4bc6e75f179475550 Mon Sep 17 00:00:00 2001 From: ilbumi Date: Sat, 16 Mar 2024 00:22:30 +0400 Subject: [PATCH] docs: add cookbook --- COOKBOOK.md | 25 +++++++++++++++++++++++++ README.md | 6 ++++-- 2 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 COOKBOOK.md diff --git a/COOKBOOK.md b/COOKBOOK.md new file mode 100644 index 0000000..7a81e4e --- /dev/null +++ b/COOKBOOK.md @@ -0,0 +1,25 @@ +# Cookbook + +A set of guides to achieve your goal. + +## Installing PyTorch + +Add specific version of PyTorch to dependencies in `pyproject.toml`: + +```toml +[project] +dependencies = [ + ... + "torch==2.0.1", + ... +] +``` + +Then add source with the desired CUDA version to the same file: + +```toml +[[tool.pdm.source]] +type = "find_links" +url = "https://download.pytorch.org/whl/cu117/torch_stable.html" +name = "torch" +``` diff --git a/README.md b/README.md index e73b6e6..600598a 100644 --- a/README.md +++ b/README.md @@ -24,17 +24,17 @@ The template is heavily inspired by [Pawamoy's Copier PDM](https://github.com/pa - [Nox](https://github.com/wntrblm/nox) as a task runner - All licenses from [choosealicense.com](https://choosealicense.com/appendix/) - Support for GitHub workflows +- VSCode Dev Containers as development environments +- Support for GitLab CI/CD ### Planned Features -- VSCode Dev Containers as development environments - Documentation built with [MkDocs](https://github.com/mkdocs/mkdocs) ([Material theme](https://github.com/squidfunk/mkdocs-material) and "autodoc" [mkdocstrings plugin](https://github.com/mkdocstrings/mkdocstrings)) - Pre-configured tools for code formatting, quality analysis and testing: - [blacken-docs](https://github.com/adamchainz/blacken-docs), support for tests - Auto-generated `CHANGELOG.md` from git commits -- Support for GitLab CI/CD ## Quick setup and usage @@ -75,3 +75,5 @@ Install your project as a Python package: ```bash pip install -U git+https://yourgit.example/project ``` + +Refer to \ No newline at end of file