Skip to content

Commit

Permalink
add installation.md (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
liangnuaa authored Jan 4, 2024
1 parent 1061fce commit 86f9873
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
We would love for you to contribute to `Instructor`.
We would love for you to contribute to `Instructor-js`.

## [Evals](https://github.com/jxnl/instructor/tree/main/tests/openai/evals)
## [Evals](https://github.com/jxnl/instructor-js/tree/main/tests/openai/evals)

We invite you to contribute evals in pytest as a way to monitor the quality of the openai models and the instructor library. To get started check out the [jxnl/instructor/tests/evals](https://github.com/jxnl/instructor/tree/main/tests/openai/evals) and contribute your own evals in the form of pytest tests. These evals will be run once a week and the results will be posted.
We invite you to contribute evals in Bun as a way to monitor the quality of the openai models and the instructor library. To get started check out the [jxnl/instructor-js/tests/evals](https://github.com/jxnl/instructor-js/tree/main/tests/openai/evals) and contribute your own evals in the form of pytest tests. These evals will be run once a week and the results will be posted.

## Issues

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ _Structured extraction in Typescript, powered by llms, designed for simplicity,
[![Documentation](https://img.shields.io/badge/docs-available-brightgreen)](https://jxnl.github.io/instructor-js)
[![GitHub issues](https://img.shields.io/github/issues/jxnl/instructor-js.svg)](https://github.com/jxnl/instructor-js/issues)

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.
Dive into the world of Typescript-based structured extraction, by OpenAI's function calling API and Zod, typeScript-first schema validation with static type inference. 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"

Expand Down
15 changes: 13 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
!!! warning "Page under construction"
Installation is as simple as:

This page is under construction. Please check back later. Consider contributing to this page by opening a PR!
!!! warning
"We haven't released instructor-js to npm yet. Please directly clone the repository and use"
```bash
npm install instructor-js
```

Instructor-js has a few dependencies:

- [`openai`](https://www.npmjs.com/package/openai): OpenAI's TypeScript / JavaScript library.
- [`zod`](https://www.npmjs.com/package/zod): TypeScript-first schema validation with static type inference.

If you've got Typescript 5.3.3+ installed, you're good to go.

0 comments on commit 86f9873

Please sign in to comment.