Skip to content

Commit

Permalink
doc and requirements update
Browse files Browse the repository at this point in the history
  • Loading branch information
liamjxu committed Apr 8, 2024
1 parent f4cff53 commit 6046922
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/install_pip.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ embedding_store.start_embedding_server(host = host, port = port)
- You can add more columns as needed using ``embedding_store.add()`;
- This will be set up on port 8501, which matches the default keyword argument `embedding_server_address` in `suql_execute`. Make sure both addresses match if you modify it.

5. Set up the backend server for the `answer`, `summary` functions. In a separate terminal, first set up OpenAI API key with `export OPENAI_API_KEY=[your OpenAI API key here]`. Write the following content into a Python script and execute in that terminal:
5. Set up the backend server for the `answer`, `summary` functions. In a separate terminal, first set up your LLM API key environment variable following [the litellm provider doc](https://docs.litellm.ai/docs/providers) (e.g., for OpenAI, run `export OPENAI_API_KEY=[your OpenAI API key here]`). Write the following content into a Python script and execute in that terminal:
```python
from suql.free_text_fcns_server import start_free_text_fncs_server

Expand All @@ -84,7 +84,7 @@ start_free_text_fncs_server(host=host, port=port)

# Test with the entry point

You should be good to go! In a separate terminal, run `export OPENAI_API_KEY=[your OpenAI API key here]`, and test with
You should be good to go! In a separate terminal, set up your LLM API key environment variable following [the litellm provider doc](https://docs.litellm.ai/docs/providers) (e.g., for OpenAI, run `export OPENAI_API_KEY=[your OpenAI API key here]`), and test with

```python
>>> from suql import suql_execute
Expand Down
2 changes: 0 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
openai==1.3.2
Jinja2==3.1.2
Flask==2.3.2
Flask-Cors==4.0.0
Flask-RESTful==0.3.10
transformers==4.38.2
torch==2.0.1
requests==2.31.0
spacy==3.7.4
tiktoken==0.4.0
Expand Down

0 comments on commit 6046922

Please sign in to comment.