Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 1.89 KB
Raw

Contributing

If you would like to contribute to this project, we recommend following the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Set Up Dev Environment

1. Clone Repo 
git clone https://github.com/georgian-io/LLM-Finetuning-Toolkit.git
cd LLM-Finetuning-Toolkit/
2. Install Dependencies
Install with Docker [Recommended] 
docker build -t llm-toolkit .
# CPU
docker run -it llm-toolkit
# GPU
docker run -it --gpus all llm-toolkit
Poetry (recommended)

See poetry documentation page for poetry installation instructions

poetry install
pip We recommend using a virtual environment like `venv` or `conda` for installation 
pip install -e .

Checklist Before Pull Request (Optional)

  1. Use ruff check --fix to check and fix lint errors
  2. Use ruff format to apply formatting
  3. Run pytest at the top level directory to run unit tests

NOTE: Ruff linting and formatting checks are done when PR is raised via Git Action. Before raising a PR, it is a good practice to check and fix lint errors, as well as apply formatting.

Releasing

To manually release a PyPI package, please run:

make build-release

Note: Make sure you have a pypi token for this PyPI repo.