Spaces:

sampazar
/

Compass-FSS-Advisor

Sleeping

App Files Files Community

Sam commited on Jun 25, 2024

Commit

13c75a7

1 Parent(s): 4726801

Updated README

Browse files

Files changed (1) hide show

README.md +39 -139

README.md CHANGED Viewed

@@ -1,152 +1,52 @@
-#Note to self: Revise this later
-# Week 4: Tuesday
-In today's assignment, we'll be creating an Open Source LLM-powered LangChain RAG Application in Chainlit.
-There are 2 main sections to this assignment:
-## Build 🏗️
-### Build Task 1: Deploy LLM and Embedding Model to SageMaker Endpoint Through Hugging Face Inference Endpoints
-#### LLM Endpoint
-Select "Inference Endpoint" from the "Solutions" button in Hugging Face:
-![image](https://i.imgur.com/6KC9TCD.png)
-Create a "+ New Endpoint" from the Inference Endpoints dashboard.
-![image](https://i.imgur.com/G6Bq9KC.png)
-Select the `NousResearch/Meta-Llama-3-8B-Instruct` model repository and name your endpoint. Select N. Virginia as your region (`us-east-1`). Give your endpoint an appropriate name. Make sure to select *at least* a L4 GPU.
-![image](https://i.imgur.com/X3YlUbh.png)
-Select the following settings for your `Advanced Configuration`.
-![image](https://i.imgur.com/c0HQ7g1.png)
-Create a `Protected` endpoint.
-![image](https://i.imgur.com/Ak8kchZ.png)
-If you were successful, you should see the following screen:
-![image](https://i.imgur.com/IBYG3wm.png)
-#### Embedding Model Endpoint
-We'll be using `Snowflake/snowflake-arctic-embed-m` for our embedding model today.
-The process is the same as the LLM - but we'll make a few specific tweaks:
-Let's make sure our set-up reflects the following screenshots:
-![image](https://i.imgur.com/IHh8FnC.png)
-After which, make sure the advanced configuration is set like so:
-![image](https://i.imgur.com/bbcrhUj.png)
-> #### NOTE: PLEASE SHUTDOWN YOUR INSTANCES WHEN YOU HAVE COMPLETED THE ASSIGNMENT TO PREVENT UNESSECARY CHARGES.
-### Build Task 2: Create RAG Pipeline with LangChain
-Follow the [notebook](https://colab.research.google.com/drive/1v1FYmvKH4gsqcdZwIT9wvbQe0GUjrc9d?usp=sharing) to create a LangChain pipeline powered by Hugging Face endpoints!
-Once you're done - please move on to Build Task 3!
-### Build Task 3: Create a Chainlit Application
-1. Create a new empty Docker space through Hugging Face - with the following settings:
-![image](https://i.imgur.com/0YzyQX7.png)
-> NOTE: You may notice the application builds slowly (~15min.) with the default free-tier hardware. The process will be faster using the `CPU upgrade` Space Hardware - though it is not required.
-2. Clone the newly created space into a directory that is *NOT IN YOUR AI MAKERSPACE REPOSITORY* using the SSH option.
-> NOTE: You may need to ensure you've added your SSH key to Hugging Face, as well as GitHub. This should already be done.
-![image](https://i.imgur.com/5RyBdP5.png)
-3. Copy and Paste (`cp ...` or through UI) the contents of `Week 4/Day 1` into the newly cloned repository.
-> NOTE: Please keep the `README.md` that was cloned from your space and delete the class `README.md`.
-4. Using the `ls` command or the `tree` command verify that you have copied over:
- - `app.py`
- - `Dockerfile`
- - `data/paul_graham_essays.txt`
- - `chainlit.md`
- - `.gitignore`
- - `.env.sample`
- - `solution_app.py`
- - `requirements.txt`
- Here is an example as the `ls -al` CLI command:
- ![image](https://i.imgur.com/vazGYeb.png)
- 5. Work through the `app.py` file to migrate your LCEL LangChain RAG Chain from the Notebook to Chainlit!
- 6. Be sure to modify your `README.md` and `chainlit.md` as you see fit!
- > NOTE: If you get stuck, there is a working reference version in `solution_app.py`.
- 7. When you are done with local testing - push your changes to your space.
- 8. Make sure you add your `HF_LLM_ENDPOINT`, `HF_EMBED_ENDPOINT`, `HF_TOKEN` as "Secrets" in your Hugging Face Space.
-### Terminating Your Resources
-Please head to the settings of each endpoint and select `Delete Endpoint`. You will need to type the name of the endpoint to delete the resources.
-### Deliverables
-- Completed Notebook
-- Chainlit Application in a Hugging Face Space Powered by Hugging Face Endpoints
-- Screenshot of endpoint usage
-Example Screen Shot:
-![image](https://i.imgur.com/qfbcVpS.png)
-## Ship 🚢
-Create a Hugging Face Space powered by Hugging Face Endpoints!
-### Deliverables
-- A short Loom of the space, and a 1min. walkthrough of the application in full
-## Share 🚀
-Make a social media post about your final application!
-### Deliverables
-- Make a post on any social media platform about what you built!
-Here's a template to get you started:
-```
-🚀 Exciting News! 🚀
-I am thrilled to announce that I have just built and shipped a open-source LLM-powered Retrieval Augmented Generation Application with LangChain! 🎉🤖
-🔍 Three Key Takeaways:
-1️⃣
-2️⃣
-3️⃣
-Let's continue pushing the boundaries of what's possible in the world of AI and question-answering. Here's to many more innovations! 🚀
-Shout out to @AIMakerspace !
-#LangChain #QuestionAnswering #RetrievalAugmented #Innovation #AI #TechMilestone
-Feel free to reach out if you're curious or would like to collaborate on similar projects! 🤝🔥
-```
-> #### NOTE: PLEASE SHUTDOWN YOUR INSTANCES WHEN YOU HAVE COMPLETED THE ASSIGNMENT TO PREVENT UNESSECARY CHARGES.

+---
+title: Midterm App
+emoji: 🏠
+colorFrom: blue
+colorTo: purple
+sdk: docker
+app_file: app.py
+pinned: false
+---
+# Midterm App
+This is the Midterm App, a project developed for the AI Engineering course. The application leverages Chainlit, LangChain, OpenAI, and Qdrant to perform retrieval-augmented generation (RAG) on a PDF document.
+## Features
+- **Document Loading**: Loads and splits a PDF document into manageable chunks.
+- **Embeddings and Retrieval**: Uses OpenAI embeddings and Qdrant for efficient document retrieval.
+- **Question Answering**: Answers questions based on the context retrieved from the document.
+- **Chainlit Integration**: Provides a chat interface for users to interact with the application.
+## Setup
+To set up and run the application locally, follow these steps:
+1. **Clone the repository**:
+   git clone https://huggingface.co/spaces/sampazar/midterm-app
+   cd midterm-app
+2. Build and run the Docker container:
+    docker build -t midterm-app .
+    docker run -p 7860:7860 midterm-app
+## Requirements
+Make sure you have the following dependencies installed if you are not using Docker:
+    Python 3.9
+    pip
+## Dependencies
+The application depends on several Python packages, which are listed in the requirements.txt file. You can install them using:
+    pip install -r requirements.txt
+## Usage
+Run the application with:
+    chainlit run app.py --port 7860
+Once the application is running, you can access it in your browser at http://localhost:7860.
+## Contributing
+Contributions are welcome! Please feel free to submit a Pull Request.
+## License
+This project is licensed under the MIT License.