Skip to content

Commit d0866d2

Browse files
committed
Fixed some typos in README
1 parent 1f510d0 commit d0866d2

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Paper QA
22

3-
43
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/whitead/paper-qa)
54
[![tests](https://github.com/whitead/paper-qa/actions/workflows/tests.yml/badge.svg)](https://github.com/whitead/paper-qa)
65
[![PyPI version](https://badge.fury.io/py/paper-qa.svg)](https://badge.fury.io/py/paper-qa)
@@ -35,7 +34,7 @@ Chen2014: Chen, Haitian, et al. "Large-scale complementary macroelectronics usin
3534

3635
## Install
3736

38-
Install from github with pip:
37+
Install with pip:
3938

4039
```bash
4140
pip install paper-qa
@@ -47,7 +46,7 @@ Make sure you have set your OPENAI_API_KEY environment variable to your [openai
4746

4847
To use paper-qa, you need to have a list of paths (valid extensions include: .pdf, .txt, .jpg, .pptx, .docx, .csv, .epub, .md, .mp4, .mp3) and a list of citations (strings) that correspond to the paths. You can then use the `Docs` class to add the documents and then query them.
4948

50-
*This uses a lot of tokens!! About 20-30k tokens per answer + embedding cost (negligible unless many documents used). That is about $0.50 per answer with current GPT-3 pricing. Use wisely.*
49+
*This uses a lot of tokens!! About 10-30k tokens per answer + embedding cost (negligible unless many documents used). That is up to $0.50 per answer with current GPT-3 pricing. Use wisely.*
5150

5251
```python
5352

@@ -64,7 +63,7 @@ answer = docs.query("What manufacturing challenges are unique to bispecific anti
6463
print(answer.formatted_answer)
6564
```
6665

67-
The answer object has the following attributes: `formatted_answer`, `answer` (answer alone), `questions`, `context` (the summaries of passages found for answer), `refernces` (the docs from which the passages came).
66+
The answer object has the following attributes: `formatted_answer`, `answer` (answer alone), `question`, `context` (the summaries of passages found for answer), `references` (the docs from which the passages came).
6867

6968
## Adjusting number of sources
7069

@@ -74,6 +73,8 @@ You can adjust the numbers of sources/passages to reduce token usage or add more
7473
docs.query("What manufacturing challenges are unique to bispecific antibodies?", k = 1, max_sources = 3)
7574
```
7675

76+
## FAQ
77+
7778
### How is this different from gpt-index?
7879

7980
gpt-index does generate answers, but in a somewhat opinionated way. It doesn't have a great way to track where text comes from and it's not easy to force it to pull from multiple documents. I don't know which way is better, but for writing scholarly text I found it to work better to pull from multiple relevant documents and then generate an answer. I would like to PR to do this to gpt-index but it looks pretty involved right now.
@@ -82,7 +83,7 @@ gpt-index does generate answers, but in a somewhat opinionated way. It doesn't h
8283

8384
I use some of my own code to pull papers from Google Scholar. This code is not included because it may enable people to violate Google's terms of service and publisher's terms of service.
8485

85-
### Saving/loading
86+
### Can I saving/loading?
8687

8788
The `Docs` class can be pickled and unpickled. This is useful if you want to save the embeddings of the documents and then load them later.
8889

0 commit comments

Comments
 (0)