Skip to content

Commit

Permalink
docs: add cookbook
Browse files Browse the repository at this point in the history
  • Loading branch information
ilbumi committed Mar 15, 2024
1 parent a998419 commit b4067ae
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
25 changes: 25 additions & 0 deletions COOKBOOK.md
Original file line number Diff line number Diff line change
@@ -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"
```
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -75,3 +75,5 @@ Install your project as a Python package:
```bash
pip install -U git+https://yourgit.example/project
```

Refer to

0 comments on commit b4067ae

Please # to comment.