Skip to content

Commit

Permalink
feat(README): add sections for OpenAI and Transformers directories an…
Browse files Browse the repository at this point in the history
…d files

Added information to README regarding directories and files for OpenAI and Transformers, including code snippets, notebooks, and packages.
  • Loading branch information
Daethyra committed Mar 22, 2024
1 parent 9d644e9 commit 254ad02
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This README:
- [Installation](#installation)
- [License](#license)

LangChain:
[LangChain](./src/langchain/):
- [Code Snippets](./src/langchain/codesnippets/ "Directory"): Here you'll find pluggable Python components.
- [bufferwindow_memory.py](./src/langchain/codesnippets/bufferwindow_memory.py "Code Snippet"): A simple memory component that can be used in a LangChain conversation.
- [chatopenai.py](./src/langchain/codesnippets/chatopenai.py "Code Snippet"): A simple LLM component that can be used to return chat messages.
Expand All @@ -41,6 +41,26 @@ LangChain:
- [Vectorstore RAG](./src/langchain/packages/vectorstore-rag/ "Directory"): Learn how to use vectorstores in LangChain.
- [Pinecone](./src/langchain/packages/vectorstore-rag/pinecone/README.md "Directory"): Use a `Pinecone` vector database "Index" as a retriever and chat with your documents.

[OpenAI](./src/opai/):
- [Code Snippets](./src/opai/codesnippets/ "Directory"): Here you'll find code snippets using the OpenAI Python library.
- [Text to Speech](./src/opai/codesnippets/tts.py "Code Snippet"): Use the Whisper API to generate speech from text.

- [Notebooks](./src/opai/notebooks/ "Directory"): Here you'll find Jupyter notebooks that show you how to use the OpenAI Python library.
- [Retrieval Augmented Generation](./src/opai/notebooks/gen-qa-openai.ipynb "Notebook"): Get started with Retrieval Augmented Generation and Pinecone to enhance the performance of your LLM.

[Transformers](./src/transformers/):
- [Code Snippets](./src/transformers/codesnippets/ "Directory"): Here you'll find code snippets using the Transformers Python library.
- [Dolphin Mixtral](./src/transformers/codesnippets/dolphin_mixtral.py "Code Snippet"): A simple function to generate text using `pipeline`.

- [Notebooks](./src/transformers/notebooks/ "Directory"): Here you'll find Jupyter notebooks that show you how to use the Transformers Python library.
- [Automatic Speech Recognition](./src/transformers/notebooks/asr_pipelines.ipynb "Notebook"): Transcribe speech using Whisper-v3 in a Gradio demo.

- [Packages](./src/transformers/packages/ "Directory"): Here you'll find CLI applications.
- [Audio Transcription](./src/transformers/packages/audiotranscription/ "Directory"):
- [MicTranscription](./src/transformers/packages/audiotranscription/mictranscription/ "CLI App"): Transcribe audio using a microphone.
- [Task Creation](./src/transformers/packages/audiotranscription/taskcreation/ "CLI App"): Generates tasks based on transcribed audio.
- [Train with Accelerate](./src/transformers/packages/trainwithaccelerate/ "Directory"): Fine tune a sequence classification model using Accelerate to make things go extra fast.

---

## Getting Started
Expand Down

0 comments on commit 254ad02

Please sign in to comment.