From 60638a54d21055d578f31b45e42dc02b64486cec Mon Sep 17 00:00:00 2001 From: Jason Liu Date: Wed, 3 Jan 2024 13:58:57 -0500 Subject: [PATCH] add links to other implementations --- README.md | 13 ++++++++++++- docs/index.md | 9 +++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b7c8f87a..f54cd3514 100644 --- a/README.md +++ b/README.md @@ -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! @@ -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" @@ -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. diff --git a/docs/index.md b/docs/index.md index daae4e164..854f20bcd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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"