Skip to content
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

Modified Readme file #51

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,30 @@ Here's the [YouTube Video](https://youtu.be/9AXP7tCI9PI).

## Installation

Install [Langchain](https://github.com/hwchase17/langchain) and other required packages.
```
pip install langchain openai chromadb tiktoken unstructured
Install [Langchain](https://github.com/hwchase17/langchain) and other required packages. And, use python version 3.9 64bit.

```sh {"id":"01HK4NXTB4EC9T3SR797GCDYV7"}
pip install langchain openai chromadb==0.3.29 tiktoken unstructured unstructured[pdf]
```

Modify `constants.py.default` to use your own [OpenAI API key](https://platform.openai.com/account/api-keys), and rename it to `constants.py`.

Place your own data into `data/data.txt`.

## Example usage

Test reading `data/data.txt` file.
```

```sh {"id":"01HK4NXTB4EC9T3SR79A5R70JM"}
> python chatgpt.py "what is my dog's name"
Your dog's name is Sunny.

```

Test reading `data/cat.pdf` file.
```

```sh {"id":"01HK4NXTB4EC9T3SR79DCGAS5K"}
> python chatgpt.py "what is my cat's name"
Your cat's name is Muffy.

```