daq27 commited on
Commit
a7790c7
1 Parent(s): 4681f54

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +45 -13
README.md CHANGED
@@ -1,13 +1,45 @@
1
- ---
2
- title: Lm Studio Gradio Chat
3
- emoji: 👁
4
- colorFrom: red
5
- colorTo: indigo
6
- sdk: gradio
7
- sdk_version: 4.26.0
8
- app_file: app.py
9
- pinned: false
10
- license: mit
11
- ---
12
-
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # LM Studio Gradio Chat
2
+ This repository contains a web-based chat application that integrates with various AI models from LM Studio, such as Mistral, OpenAI, and Llama, via a user-friendly Gradio interface. It is designed to maintain conversation history, providing a coherent and continuous AI chat experience comparable to systems like ChatGPT or Claude.
3
+
4
+ ## Features
5
+ - **Multiple AI Model Integration**: Integrates with a variety of conversational AI models hosted on LM Studio, including Mistral, OpenAI, Llama, and more, offering flexibility in choosing the AI technology.
6
+ - **Real-time Interaction**: Engage with different AI models in real-time through a Gradio interface for a dynamic chat experience.
7
+ - **Contextual Conversations**: Maintains a conversation history to provide context to the AI models, enabling more coherent and meaningful interactions, similar to advanced systems like ChatGPT or Claude.
8
+ - **User-Friendly Interface**: Simple and intuitive UI built with Gradio, making it accessible for users with any level of technical expertise.
9
+
10
+ ## Installation
11
+ To get started with this project, you'll need to set up your Python environment and install the necessary dependencies.
12
+
13
+ ### Prerequisites
14
+ - Python 3.8 or higher
15
+ - Access to LM Studio with a running instance of the Mistral model
16
+
17
+ ### Setup
18
+ 1. Clone this repository:
19
+ ```bash
20
+ git clone https://huggingface.co/your-username/your-repo-name
21
+ cd your-repo-name
22
+ ```
23
+
24
+ 2. Install the required Python libraries:
25
+ ```bash
26
+ pip install -r requirements.txt
27
+ ```
28
+
29
+ 3. Launch the Application:
30
+ ```bash
31
+ python main.py
32
+ ```
33
+
34
+ ### Usage
35
+ Once you have completed the installation, you can start the application by running:
36
+ ```bash
37
+ python main.py
38
+ ```
39
+ This will launch the Gradio interface in your default web browser, where you can interact with the Mistral model directly.
40
+
41
+ ## Contributing
42
+ Contributions to this project are welcome! Please feel free to fork the repository, make your changes, and submit a pull request.
43
+
44
+ ## License
45
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.