Skip to content
This repository has been archived by the owner on Sep 24, 2024. It is now read-only.

Commit

Permalink
add pypi docs
Browse files Browse the repository at this point in the history
  • Loading branch information
veekaybee committed Mar 12, 2024
1 parent a19ea24 commit 6f3616b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,8 @@ The publishing workflow can be triggered in two ways:
1. Manually triggered on the GitHub Actions UI, which publishes the package to TestPyPI, or
2. Triggered by the creation of a GitHub release, which publishes to real PyPI.
When creating a GitHub release, make sure that the tag used for the release
matches the version of the target code branch.
Note that there are some limitations on publishing to PyPI which are relevant to `lm-buddy`.
For instance, we can't publish a package that has git-hash pinned dependencies because [PyPI requirements dictate](https://github.com/pypi/warehouse/blob/fca2efaee722cceef87e3e61926426de090db03b/warehouse/forklift/legacy.py#L280) that all packages be version-based.
When creating a GitHub release, make sure that the tag you create in the GitHub release UI
matches the version of the target code branch specified in `pyproject.toml`.
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to the documentation!
lm-buddy documentation
====================================
LM Buddy is a collection of jobs for finetuning and evaluating open-source (large) language models.
The library makes use of YAML-based configuration files as inputs to CLI commands for each job,
and tracks input/output data with [Weights & Biases](https://docs.wandb.ai/) artifacts.
and tracks input/output data with Weights and Biases artifacts.

Getting Started
---------------
Expand Down

0 comments on commit 6f3616b

Please sign in to comment.