Skip to content

Commit

Permalink
add links to other implementations
Browse files Browse the repository at this point in the history
  • Loading branch information
jxnl committed Jan 3, 2024
1 parent 5b0936b commit 60638a5
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ _Structured extraction in Python, powered by OpenAI's function calling API, desi

Dive into the world of Python-based structured extraction, empowered by OpenAI's cutting-edge function calling API. Instructor stands out for its simplicity, transparency, and user-centric design. Whether you're a seasoned developer or just starting out, you'll find Instructor's approach intuitive and its results insightful.

## Ports to other languages

Check out ports to other languages below:

- [Typescript / Javascript](https://www.github.com/jxnl/instructor-js)
- [Elixir](https://github.com/thmsmlr/instructor_ex/)

If you want to port Instructor to another language, please reach out to us on [Twitter](https://twitter.com/jxnlco) we'd love to help you get started!

## Get Started in Moments

Installing Instructor is a breeze. Simply run `pip install instructor` in your terminal and you're on your way to a smoother data handling experience!
Expand All @@ -29,9 +38,11 @@ Our `instructor.patch` for the `OpenAI` class introduces three key enhancements:
- **Validation Context:** Provide a context object for enhanced validator access. A Glimpse into Instructor's Capabilities.

### Using Validators

To learn more about validators, checkout our blog post [Good LLM validation is just good validation](https://jxnl.github.io/instructor/blog/2023/10/23/good-llm-validation-is-just-good-validation/)

## Usage

With Instructor, your code becomes more efficient and readable. Here’s a quick peek:

```py hl_lines="5 13"
Expand Down Expand Up @@ -147,7 +158,7 @@ assert user.age == 25

## Pydantic Validation

Validation can also be plugged into the same Pydantic model.
Validation can also be plugged into the same Pydantic model.

In this example, if the answer attribute contains content that violates the rule "Do not say objectionable things", Pydantic will raise a validation error.

Expand Down
9 changes: 9 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ _Structured extraction in Python, powered by llms, designed for simplicity, tran

Dive into the world of Python-based structured extraction, by OpenAI's function calling API and Pydantic, the most widely used data validation library for Python. Instructor stands out for its simplicity, transparency, and user-centric design. Whether you're a seasoned developer or just starting out, you'll find Instructor's approach intuitive and steerable.

!!! tip "Support in other languages"

Check out ports to other languages below:

- [Typescript / Javascript](https://www.github.com/jxnl/instructor-js)
- [Elixir](https://github.com/thmsmlr/instructor_ex/)

If you want to port Instructor to another language, please reach out to us on [Twitter](https://twitter.com/jxnlco) we'd love to help you get started!

## Usage

```py hl_lines="5 13"
Expand Down

0 comments on commit 60638a5

Please sign in to comment.