Skip to content

Commit

Permalink
requirements txt file added, readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
eren23 committed Mar 24, 2023
1 parent c84c6a3 commit ec667dc
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
<!-- Use the context of other files to complete here -->
![knowledgegpt](static_files/logo.png)

# Installation

1. Check Dependencies: ` pip install spacy download en_core_web_sm ffmpeg`

2. Run in terminal: `pip install knowledgegpt`

## Pypi Link: https://pypi.org/project/knowledgegpt/


# knowledgegpt

Expand All @@ -25,6 +17,16 @@ documents (Docs). Additionally, it can extract text from YouTube subtitles and a
and use it as a source of information. This allows for a diverse range of information to be gathered and used for
generating prompts and answers.

## Pypi Link: https://pypi.org/project/knowledgegpt/

# Installation

1. PyPI installation, run in terminal: `pip install knowledgegpt`

2. Or you can use the latest version from the repository: `pip install -r requirements.txt` and then `pip install .`

3. Download needed language model for parsing: `python3 -m spacy download en_core_web_sm`

## How to use

#### Restful API
Expand Down Expand Up @@ -132,7 +134,7 @@ docker run -p 8888:8888 knowledgegptimage
- [x] FAISS support
- [ ] Add a vector database (Pinecone, Milvus, Qdrant etc.)
- [x] Add Whisper Model
- [ ] Add Whisper Local Support (not over openai API)
- [x] Add Whisper Local Support (not over openai API)
- [ ] Add Whisper for audio longer than 25MB
- [ ] Add a web interface
- [ ] Migrate to Promptify for prompt generation
Expand All @@ -149,10 +151,10 @@ docker run -p 8888:8888 knowledgegptimage
- [ ] Add a better error handling system
- [ ] Add a better testing system
- [ ] Add a better CI/CD system
- [ ] Dockerize the project
- [x] Dockerize the project
- [ ] Add search engine support, such as Google, Bing, etc.
- [ ] Add support for opensource OpenAI alternatives (for answer generation)
- [ ] Evaluating dependecies and removing unnecessary ones
- [ ] Evaluating dependencies and removing unnecessary ones
- [ ] Providing prompt flexibility for using with whatever model

( To be extended...)
Expand Down
18 changes: 18 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
fastapi
pandas
numpy
scikit-learn
transformers
python-docx
beautifulsoup4
requests
openai
spacy
sentence-transformers
yt_dlp
tiktoken
pydub
PyPDF2
python-pptx
faiss-cpu
cloudscraper

0 comments on commit ec667dc

Please sign in to comment.