Skip to content

Readme updates #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Sep 9, 2024
Merged

Readme updates #323

merged 9 commits into from
Sep 9, 2024

Conversation

mskarlin
Copy link
Collaborator

@mskarlin mskarlin commented Sep 8, 2024

Prepping the new readme to capture all the recent work and re-introduce PaperQA.

Added a little baby change for an edge case that I found via parsing tons of documents -- sometimes weak LLMs will try to add a list of authors that's empty to the docs object after peeking.

@mskarlin mskarlin changed the title [WIP]Readme updates Readme updates Sep 9, 2024
@mskarlin mskarlin marked this pull request as ready for review September 9, 2024 20:15
pip install paper-qa[agents]
```

PaperQA uses an LLM to operate, so you'll need to either set an appropriate [API key environment variable](https://docs.litellm.ai/docs/providers) (i.e. `export OPENAI_API_KEY=sk-...`) or set up an open source LLM server (i.e. using [ollama](https://github.com/ollama/ollama)). Any LiteLLM compatible model can be configured to use with PaperQA.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you mention litellm here

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

more than the last sentence?

@mskarlin mskarlin merged commit 0c59bb0 into september-2024-release Sep 9, 2024
1 of 2 checks passed
@mskarlin mskarlin deleted the readme-updates branch September 9, 2024 20:45
@whitead whitead mentioned this pull request Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants