From ca3705c47155ab2723187fb54b314a0cc49c1995 Mon Sep 17 00:00:00 2001 From: Alex Remedios Date: Tue, 24 Oct 2023 18:56:45 +0100 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a242d4..fc659ad 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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. @@ -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 \ No newline at end of file +## TODO make phoenix optional, fix empty packages bug