Contribution

Contribution

There has been a lot of interest in tinygrad lately. Here are some basic guidelines for contributing:

  • Bug fixes are the best and always welcome! Like this one (opens in a new tab).
  • If you don't understand the code you are changing, don't change it!
  • All code golf PRs will be closed, but conceptual cleanups (opens in a new tab) are great.
  • Features are welcome. Though if you are adding a feature, you need to include tests.
  • Improving test coverage is great, with reliable non-brittle tests.

Additional guidelines can be found in CONTRIBUTING.md (opens in a new tab)

Running tests

For more examples on how to run the full test suite please refer to the CI workflow (opens in a new tab).

Some examples:

python3 -m pip install -e '.[testing]'
python3 -m pytest
python3 -m pytest -v -k TestTrain
python3 ./test/models/test_train.py TestTrain.test_efficientnet
SGDabs
;