Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jxnl committed Jan 6, 2024
1 parent 0003ce5 commit 4f4449b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
6 changes: 4 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
We would love for you to contribute to `Instructor-js`.

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

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.
Theres a bunch of examples in the python version, including documentation here [python docs](https://jxnl.github.io/instructor/examples/)

If you want to contribute, please check out [issues](https://github.com/jxnl/instructor-js/issues/8)

## Issues

Expand Down
6 changes: 5 additions & 1 deletion docs/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

!!! warning "Page under construction"

This page is under construction. Please check back later. Consider contributing to this page by opening a PR!
This page is under construction. Please check back later. Consider contributing to this page by opening a PR! Theres a bunch of examples in the python version, including documentation here [python docs](https://jxnl.github.io/instructor/examples/)

If you want to contribute, please check out [issues](https://github.com/jxnl/instructor-js/issues/8)



## Table of Contents

Expand Down

0 comments on commit 4f4449b

Please sign in to comment.