Truss was first created at Baseten, but as an open and living project eagerly accepts contributions of all kinds from the broader developer community. Please note that all participation with Truss falls under our code of conduct.
We use GitHub features for project management on Truss:
- For bugs and feature requests, file an issue.
- For changes and updates, create a pull request.
- To view and comment on the roadmap, check the projects tab.
To get started contributing to the library, all you have to do is clone this repository!
PLEASE NOTE: the ML ecosystem in general is still not well supported on M1 Macs, and as such, we do not recommend or support local development on M1 for Truss. Truss is well-optimized for use with GitHub Codespaces and other container-based development environments.
We use asdf to manage Python binaries and poetry to manage Python dependencies.
For development in a macOS environment, we use brew to manage system packages.
# Install asdf (or use another method https://asdf-vm.com/)
brew install asdf
# Install `asdf` managed python and poetry
asdf plugin add python
asdf plugin add poetry
# Install poetry dependencies
poetry install
# And finally precommit
poetry run pre-commit install
Then to run the entire test suite
poetry run pytest truss/tests
When releasing a version of the library with user-facing changes, be sure to update the changelog with an overview of the changes, along with updating any relevant documentation. Feel free to tag @philipkiely-baseten to write or review any changelog or docs updates. To release a new version of the library.
- Create a PR changing the
pyproject.tomlversion - Merge the PR, github actions will auto deploy if it detects the change
- Create a tag on a commit `git tag -a -m "vX.X.X" vX.X.X
- Push the tag
git push -u origin vX.X.X
To learn about Truss see the official documentation.
Contributions to documentation are very welcome! Simply edit the appropriate markdown files in the docs/ folder and make a pull request. For larger changes, tutorials, or any questions please contact [email protected].