diff --git a/README.md b/README.md index 0c045efc..b62fe60a 100644 --- a/README.md +++ b/README.md @@ -1 +1,75 @@ -# outlines-core +
+ +Outlines-core Logo + +[![Contributors][contributors-badge]][contributors] + +*Structured generation (in Rust).* +
+ +This package provides the core functionality for structured generation, formerly implemented in [Outlines][outlines], with a focus on performance and portability. + +# Install + +We provide bindings to the following languages: +- [Rust][rust-implementation] (Original implementation) +- [Python][python-bindings] + +The latest release of the Python bindings is available on PyPi using `pip`: + +``` python +pip install outlines-core +``` + +The current development branch of `outlines-core` can be installed from GitHub, also using `pip`: + +``` shell +pip install git+https://github.com/outlines-dev/outlines-core +``` + +# How to contribute? + +## Setup + +First, fork the repository on GitHub and clone the fork locally: + +```bash +git clone git@github.com/YourUserName/outlines-core.git +cd outlines-core +``` + +Create a new virtual environment: + +``` bash +python -m venv .venv +source .venv/bin/activate +``` + +Then install the dependencies in editable mode, and install the pre-commit hooks: + +``` bash +pip install -e ".[test]" +pre-commit install +``` + +## Before pushing your code + +Run the tests: + + +``` bash +pytest +``` + +And run the code style checks: + +``` bash +pre-commit run --all-files +``` + + +[outlines]: https://github.com/dottxt-ai/outlines +[contributors]: https://github.com/outlines-dev/outlines-core/graphs/contributors +[contributors-badge]: https://img.shields.io/github/contributors/outlines-dev/outlines-core?style=flat-square&logo=github&logoColor=white&color=ECEFF4 +[rust-implementation]: https://github.com/outlines-dev/outlines-core/tree/readme/src +[python-bindings]: https://github.com/outlines-dev/outlines-core/tree/readme/python/outlines_core diff --git a/docs/assets/images/logo.png b/docs/assets/images/logo.png new file mode 100644 index 00000000..22bc659d Binary files /dev/null and b/docs/assets/images/logo.png differ diff --git a/docs/assets/images/logo.svg b/docs/assets/images/logo.svg new file mode 100644 index 00000000..239310dd --- /dev/null +++ b/docs/assets/images/logo.svg @@ -0,0 +1,247 @@ + + + +outlines-core