kennethreitz/instructor
1
0
Fork 0
mirror of https://github.com/kennethreitz/instructor.git synced 2026-06-05 22:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: more links!

Browse Source
This commit is contained in:
Jason Liu
2024-02-21 11:27:38 -05:00
parent 13683b7cad
commit 75bf98e0e5
1 changed files with 3 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/index.md
+3 -15
View File
@@ -8,23 +8,11 @@ _Structured outputs powered by llms. Designed for simplicity, transparency, and
[![Discord](https://img.shields.io/discord/1192334452110659664?label=discord)](https://discord.gg/CV8sPM5k5Y)
[![Downloads](https://img.shields.io/pypi/dm/instructor.svg)](https://pypi.python.org/pypi/instructor)
Instructor stands out for its simplicity, transparency, and user-centric design. We leverage Pydantic to do the heavy lifting, and we've built a simple, easy-to-use API on top of it by helping you manage [validation context](./concepts/reask_validation.md), retries with [Tenacity](./concepts/retrying.md), and streaming [Lists](./concepts/lists.md) and [Partial](./concepts/partial.md) responses.
Instructor makes it easy to reliably get structured data like JSON from Large Language models like GPT-3.5, GPT-4, GPT-4-Vision, including open source models like Mistral from [Together](./hub/together.md), [Anyscale](./hub/anyscale.md), [Ollama](./hub/ollama.md), and [llama-cpp-python](./hub/llama-cpp-python.md).
Check us out in [Typescript](https://instructor-ai.github.io/instructor-js/) and [Elixir](https://github.com/thmsmlr/instructor_ex/).
By leveraging various modes like Function Calling, Tool Calling and even constrained sampling modes like JSON mode, JSON Schema; Instructor stands out for its simplicity, transparency, and user-centric design. We leverage Pydantic to do the heavy lifting, and we've built a simple, easy-to-use API on top of it by helping you manage [validation context](./concepts/reask_validation.md), retries with [Tenacity](./concepts/retrying.md), and streaming [Lists](./concepts/lists.md) and [Partial](./concepts/partial.md) responses.
!!! tip "Not limited to the OpenAI API"
Instructor is not limited to the OpenAI API, we have support for many other backends that via patching. Check out more on [patching](./concepts/patching.md).
1. Wrap OpenAI's SDK
2. Wrap the create method
Including but not limited to:
- [Together](./hub/together.md)
- [Ollama](./hub/ollama.md)
- [AnyScale](./hub/anyscale.md)
- [llama-cpp-python](./hub/llama-cpp-python.md)
We also provide library in [Typescript](https://instructor-ai.github.io/instructor-js/) and [Elixir](https://github.com/thmsmlr/instructor_ex/).
## Usage