Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-treebeard authored Oct 24, 2023
1 parent b08c3d6 commit ca3705c
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ Your outputs will be in your current directory

### Generate guides for my closed-source code

You will need to install the 'rag' extra `pip install 'nbwrite[rag]'`

By default, OpenAI's models can generate docs based on parametric knowledge.
This is limited to popular open source libraries.

Expand Down Expand Up @@ -117,6 +119,8 @@ See OpenAI usage here https://platform.openai.com/account/usage
This is an Alpha stage product, and we encourage you to investigate and report bugs
You will need to install the 'tracing' extra `pip install 'nbwrite[tracing]'`

For any errors occurring during the main generation process, it's possible to view traces
using Phoenix.

Expand All @@ -134,4 +138,4 @@ using Phoenix.
1. Check the phoenix traces in the dashboard (default http://127.0.0.1:6060/)


## TODO make phoenix optional, fix empty packages bug
## TODO make phoenix optional, fix empty packages bug

0 comments on commit ca3705c

Please sign in to comment.