Skip to content

Commit

Permalink
chore: added readme instructions to install from pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
benlipkin committed Sep 23, 2024
1 parent d4fe040 commit fca7f60
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,10 @@ Scaling inference thoughtfully is where the next breakthrough gains will come in

## Getting started

For now, install from source. Coming soon to `PyPi`.
Install directly from [PyPi](https://pypi.org/project/decoding/)

```bash
git clone git@github.com:benlipkin/decoding.git
cd decoding/
python -m pip install .
python -m pip install decoding
```

See [Contributing](https://github.com/benlipkin/decoding#documentation) for how to build the dev and testing environment.
Expand Down Expand Up @@ -64,13 +62,16 @@ We welcome community contributions. Open an issue or a pull request if you see a
To get started with development, this library supports an automated build of the dev and testing env using [GNU Make](https://www.gnu.org/software/make/).

```bash
make env # install library in current env
# clone repo and install lib in current env
git clone git@github.com:benlipkin/decoding.git
cd decoding/
make env
```

Before opening a PR, make sure all tests are passing:

```bash
make tests # run linting, type-checking, and unit-tests
make tests
```


Expand Down
9 changes: 7 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
Setup file for the decoding library.
"""

import pathlib

import setuptools

core_requirements = [
Expand All @@ -19,11 +21,14 @@
"ruff==0.6.7",
]

with pathlib.Path("README.md").open(encoding="utf-8") as f:
readme = f.read()

setuptools.setup(
name="decoding",
version="0.1.0",
description="Composable LLM decoding algorithms",
long_description="See https://github.com/benlipkin/decoding for more information.",
description="Composable inference algorithms with LLMs and programmable logic",
long_description=readme,
long_description_content_type="text/markdown",
authors=["Ben Lipkin"],
license="Apache 2.0",
Expand Down

0 comments on commit fca7f60

Please sign in to comment.