maclenn77 commited on
Commit
71b69c9
1 Parent(s): ba6b3cf

fix typos on README.md (#16)

Browse files
Files changed (1) hide show
  1. README.md +6 -6
README.md CHANGED
@@ -19,7 +19,7 @@ GnosisPages offers you the following key features:
19
  - **Upload PDF files**: Upload PDF files until 200MB size. PDF files should be programmatically created or processed by an OCR tool.
20
  - **Extract and split text**: Extract the content of your PDF files and split them for a better querying.
21
  - **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)
22
- - **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.
23
 
24
  ## Demo
25
 
@@ -31,7 +31,7 @@ GnosisPages offers you the following key features:
31
 
32
  For using the demo, you only need an OpenAI API Key.
33
 
34
- If you prefer to clone the project and run on your local environment, you will require:
35
 
36
  - Python ( developed with v3.11)
37
  - OpenAI API Key
@@ -59,7 +59,7 @@ Follow the next steps to set up GnosisPages in your local environment:
59
  touch .env
60
  nano .env # or your prefered text editor
61
  ```
62
- And add your OpenAI API Key on it.
63
  ```yaml
64
  OPENAI_API_KEY=YOUR_OPENAI_API_KEY
65
  ```
@@ -76,11 +76,11 @@ Follow the next steps to set up GnosisPages in your local environment:
76
 
77
  GnosisPages's repo includes workflows for deploying to HuggingFace.
78
 
79
- 1. **Check file size**: Prevents you to merge and deploy files over the limit provided by HuggingFace 🤗.
80
  2. **Check lints**: Analize the code with pylint.
81
- 3. **Deploy to HuggingFace**: Once a branch is merged into main, the last version is deployed on your HuggingFace Space.
82
 
83
- 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`.
84
 
85
  ## Feedback and Contributions
86
  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.
 
19
  - **Upload PDF files**: Upload PDF files until 200MB size. PDF files should be programmatically created or processed by an OCR tool.
20
  - **Extract and split text**: Extract the content of your PDF files and split them for a better querying.
21
  - **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)
22
+ - **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.
23
 
24
  ## Demo
25
 
 
31
 
32
  For using the demo, you only need an OpenAI API Key.
33
 
34
+ If you prefer to clone the project and run on local environment, you will require:
35
 
36
  - Python ( developed with v3.11)
37
  - OpenAI API Key
 
59
  touch .env
60
  nano .env # or your prefered text editor
61
  ```
62
+ And add your OpenAI API Key.
63
  ```yaml
64
  OPENAI_API_KEY=YOUR_OPENAI_API_KEY
65
  ```
 
76
 
77
  GnosisPages's repo includes workflows for deploying to HuggingFace.
78
 
79
+ 1. **Check file size**: Prevents to merge and deploy files over the limit provided by HuggingFace 🤗.
80
  2. **Check lints**: Analize the code with pylint.
81
+ 3. **Deploy to HuggingFace**: Once a branch is merged into main, the last version is deployed on a HuggingFace Space.
82
 
83
+ 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`.
84
 
85
  ## Feedback and Contributions
86
  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.