From 3fc2cd1d6199649e34d8a57a466d7533053a701a Mon Sep 17 00:00:00 2001 From: Dariusz Debowczyk Date: Fri, 1 Mar 2024 15:09:17 +0100 Subject: [PATCH] doc: references to PHP port added to docs (#474) --- .gitignore | 3 ++- README.md | 2 +- docs/hub/together.md | 2 +- docs/index.md | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index fbe9c99..613bf6b 100644 --- a/.gitignore +++ b/.gitignore @@ -160,7 +160,8 @@ cython_debug/ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. -#.idea/ +.idea/ + examples/citation_with_extraction/fly.toml my_cache_directory/ tutorials/wandb/* diff --git a/README.md b/README.md index 75d4813..3e40932 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ _Structured outputs powered by llms. Designed for simplicity, transparency, and 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](./docs/concepts/reask_validation.md), retries with [Tenacity](./docs/concepts/retrying.md), and streaming [Lists](./docs/concepts/lists.md) and [Partial](./docs/concepts/partial.md) responses. -Check us out in [Typescript](https://instructor-ai.github.io/instructor-js/) and [Elixir](https://github.com/thmsmlr/instructor_ex/). +Check us out in [Typescript](https://instructor-ai.github.io/instructor-js/), [Elixir](https://github.com/thmsmlr/instructor_ex/) and [PHP](https://github.com/cognesy/instructor-php/). Instructor is not limited to the OpenAI API, we have support for many other backends that via patching. Check out more on [patching](./docs/concepts/patching.md). diff --git a/docs/hub/together.md b/docs/hub/together.md index 5fd6776..49ce483 100644 --- a/docs/hub/together.md +++ b/docs/hub/together.md @@ -24,7 +24,7 @@ By the end of this blog post, you will learn how to effectively utilize instruct !!! note "Other Languages" This blog post is written in Python, but the concepts are applicable to other languages as well, as we currently have support for [Javascript]( - https://instructor-ai.github.io/instructor-js) and [Elixir](https://hexdocs.pm/instructor/Instructor.html) + https://instructor-ai.github.io/instructor-js), [Elixir](https://hexdocs.pm/instructor/Instructor.html) and [PHP](https://github.com/cognesy/instructor-php/). diff --git a/docs/index.md b/docs/index.md index e208a48..9dd0e0f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,7 +12,7 @@ Instructor makes it easy to reliably get structured data like JSON from Large La 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. -We also provide library in [Typescript](https://instructor-ai.github.io/instructor-js/) and [Elixir](https://github.com/thmsmlr/instructor_ex/). +We also provide library in [Typescript](https://instructor-ai.github.io/instructor-js/), [Elixir](https://github.com/thmsmlr/instructor_ex/) and [PHP](https://github.com/cognesy/instructor-php/). ## Usage