Merge branch 'main' of https://github.com/ViperX7/Alpaca-Turbo

README.md

@@ -12,34 +12,21 @@
 Alpaca-Turbo is a language model that can be run locally without much setup required. It is a user-friendly web UI for the alpaca.cpp language model based on LLaMA, with unique features that make it stand out from other implementations. The goal is to provide a seamless chat experience that is easy to configure and use, without sacrificing speed or functionality.
 
 ## 📝 Example views
-### Chat Frontpage
-![Alpaca-Turbo Screenshot 2](./screenshots/screenshot2.png)
 
-### Chat functionality
-![Alpaca-Turbo Screenshot 1](./screenshots/screenshot1.png)
 
-## 📦 Installation Steps
+https://user-images.githubusercontent.com/38191717/234747316-2e8d5f55-73f2-4f42-ad9a-11114de1825b.mp4
 
-### 📺 Video Instructions
-- [Windows](https://drive.google.com/file/d/1771mvqo6LgU8El1A8-m4vxXHPE-gy91u/view?usp=sharing)
-- [Mac](https://www.youtube.com/watch?v=bGcrTGsSNaY)
 
-#### 🐳 Using Docker (only Linux is supported with docker)
 
-**Note**: for some reason this docker container works on Linux but not on Windows
+## 📦 Installation Steps
 
-> Docker must be installed on your system
+### 📺 Video Instructions
+- ToDo
+- ToDo
 
-1. Download the [latest alpaca-turbo.zip from the release page](https://github.com/ViperX7/Alpaca-Turbo/releases/latest).
-2. Extract the contents of the zip file into a directory named alpaca-turbo.
-3. Copy your alpaca models to alpaca-turbo/models/ directory.
-4. Run the following command to set everything up:
-   ```
-    docker-compose up
-   ```
-5. Visit http://localhost:7887 to use the chat interface of the chatbot.
+#### 🐳 Using Docker (only Linux is supported with docker)
+- ToDo
 
-**OR**
 
 #### 🪟 Using Windows (standalone or miniconda) AND Mac M1/M2 (using miniconda)
 
@@ -61,14 +48,22 @@ Alpaca-Turbo is a language model that can be run locally without much setup requ
 6. close that window
 7. open a new cmd window in your Alpaca-Turbo dir and type
    ```
-   conda create -n alpaca_turbo python=3.8 -y
+   conda create -n alpaca_turbo python=3.10 -y
    conda activate alpaca_turbo
    pip install -r requirements.txt
-   python api.py
+   python app.py
    ```
-8. Visit http://localhost:7887 select your model and click change wait for the model to load
+
 9. ready to interact
 
+#### Directly installing with Pip
+just get the latest release unzip and then run 
+
+```
+pip install -r requirements.txt
+python app.py
+```
+
 ## 💁 Contributing
 
 As an open source project in a rapidly developing field, I am open to contributions, whether it be in the form of a new feature, improved infra, or better documentation.