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.

Sign up for GitHub

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

fix typos on README.md #16

Merged
merged 1 commit into from
Dec 10, 2023
Merged

fix typos on README.md #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ GnosisPages offers you the following key features:
- **Upload PDF files**: Upload PDF files until 200MB size. PDF files should be programmatically created or processed by an OCR tool.
- **Extract and split text**: Extract the content of your PDF files and split them for a better querying.
- **Store in a client-side VectorDB**: GnosisPages uses ChromaDB for storing the content of your pdf files on vectors (ChromaDB use by default "all-MiniLM-L6-v2" for embeddings)
- **Consult the info of your knowledge base": Ask questions to the Intelligent Assitant about the content of your knowledge base. The Langchain Agent will use the ChromaDB query functions as a tool.
- **Consult the info of your knowledge base**: Ask questions to the Intelligent Assitant about the content of your knowledge base. The Langchain Agent will use ChromaDB query functions as a tool.

## Demo

Expand All @@ -31,7 +31,7 @@ GnosisPages offers you the following key features:

For using the demo, you only need an OpenAI API Key.

If you prefer to clone the project and run on your local environment, you will require:
If you prefer to clone the project and run on local environment, you will require:

- Python ( developed with v3.11)
- OpenAI API Key
Expand Down Expand Up @@ -59,7 +59,7 @@ Follow the next steps to set up GnosisPages in your local environment:
touch .env
nano .env # or your prefered text editor
```
And add your OpenAI API Key on it.
And add your OpenAI API Key.
```yaml
OPENAI_API_KEY=YOUR_OPENAI_API_KEY
```
Expand All @@ -76,11 +76,11 @@ Follow the next steps to set up GnosisPages in your local environment:

GnosisPages's repo includes workflows for deploying to HuggingFace.

1. **Check file size**: Prevents you to merge and deploy files over the limit provided by HuggingFace 🤗.
1. **Check file size**: Prevents to merge and deploy files over the limit provided by HuggingFace 🤗.
2. **Check lints**: Analize the code with pylint.
3. **Deploy to HuggingFace**: Once a branch is merged into main, the last version is deployed on your HuggingFace Space.
3. **Deploy to HuggingFace**: Once a branch is merged into main, the last version is deployed on a HuggingFace Space.

For deploying, you need to add `HF_TOKEN` as secret in the settings of your fork and add yoyr HuggingFace user with the variable name `HF_USERNAME`.
For deploying, you need to add `HF_TOKEN` as secret in the settings of your fork and add a HuggingFace user with the variable name `HF_USERNAME`.

## Feedback and Contributions
If you have any feedback or would like to contribute to GnosisPages's development, please feel free to open issues or submit pull requests in the GitHub repository.
Expand Down
Loading