Sanchit Verma commited on
Commit
0b0305c
Β·
1 Parent(s): abcf75a

Update README and add Hugging Face configuration

Browse files

- Update README to reflect primary support for OpenRouter models
- Add Hugging Face configuration file for deployment
- Update default persona and repository URL
- Clarify backend options and dependencies

Files changed (2) hide show
  1. README.md +22 -13
  2. huggingface.yaml +3 -0
README.md CHANGED
@@ -1,11 +1,11 @@
1
  # πŸ€– LLMates – Chat with Custom AI Personas
2
 
3
- LLMates is a minimal, modular chatbot application that allows you to switch between different AI assistant personas powered by language models. The application supports both cloud-based (OpenAI) and local (Ollama) model backends.
4
 
5
  ## πŸš€ Features
6
 
7
  - Multiple AI personas with distinct personalities and expertise
8
- - Support for OpenAI models (including GPT-4o) and local models via Ollama
9
  - Simple and intuitive Gradio-based web interface
10
  - Easy configuration through environment variables
11
 
@@ -13,14 +13,14 @@ LLMates is a minimal, modular chatbot application that allows you to switch betw
13
 
14
  - **Python Tutor**: Get help with Python programming concepts and debugging
15
  - **Regex Helper**: Expert assistance with regular expressions
16
- - **Motivational Coach**: Encouraging and inspiring conversations
17
  - **Startup Advisor**: Practical advice for startups and entrepreneurship
18
 
19
  ## πŸ› οΈ Installation
20
 
21
  1. Clone the repository:
22
  ```bash
23
- git clone https://github.com/yourusername/llmates.git
24
  cd llmates
25
  ```
26
 
@@ -33,19 +33,26 @@ LLMates is a minimal, modular chatbot application that allows you to switch betw
33
 
34
  ## βš™οΈ Configuration
35
 
36
- Copy the example `.env` file and update it with your settings:
37
 
38
  ```env
39
- # OpenAI Configuration (required if not using Ollama)
40
- OPENAI_API_KEY=your_openai_api_key
41
- OPENAI_MODEL=gpt-4o # or any other OpenAI model
42
 
43
- # Ollama Configuration (set to true to use local models)
44
- USE_OLLAMA=false
45
- OLLAMA_MODEL=llama3 # or any other Ollama model
 
 
 
 
 
 
 
 
 
46
 
47
  # Application Settings
48
- DEFAULT_PERSONA="Python Tutor"
49
  TEMPERATURE=0.7
50
  MAX_TURNS=10
51
  ```
@@ -63,6 +70,8 @@ The application will start a local web server, and you can access it in your bro
63
  ## πŸ› οΈ Tech Stack
64
 
65
  - **UI**: Gradio
66
- - **Backend**: OpenAI API / Ollama
 
67
  - **Language**: Python 3.8+
68
  - **Configuration**: Environment variables via python-dotenv
 
 
1
  # πŸ€– LLMates – Chat with Custom AI Personas
2
 
3
+ LLMates is a minimal, modular chatbot application that allows you to switch between different AI assistant personas powered by OpenRouter's language models. The application also supports OpenAI and local models via Ollama as alternative backends.
4
 
5
  ## πŸš€ Features
6
 
7
  - Multiple AI personas with distinct personalities and expertise
8
+ - Primary support for OpenRouter's wide range of models (including GPT-4, Claude, and more)
9
  - Simple and intuitive Gradio-based web interface
10
  - Easy configuration through environment variables
11
 
 
13
 
14
  - **Python Tutor**: Get help with Python programming concepts and debugging
15
  - **Regex Helper**: Expert assistance with regular expressions
16
+ - **Motivational Coach**: Encouraging and inspiring conversations (default)
17
  - **Startup Advisor**: Practical advice for startups and entrepreneurship
18
 
19
  ## πŸ› οΈ Installation
20
 
21
  1. Clone the repository:
22
  ```bash
23
+ git clone https://github.com/sanchitv7/llmates.git
24
  cd llmates
25
  ```
26
 
 
33
 
34
  ## βš™οΈ Configuration
35
 
36
+ Copy the example `.env` file and update it with your preferred settings:
37
 
38
  ```env
39
+ # Choose one of the following backends
 
 
40
 
41
+ ## OpenRouter
42
+ USE_OPENROUTER=true
43
+ OPENROUTER_API_KEY=your_openrouter_api_key
44
+ OPENROUTER_MODEL=meta-llama/llama-3-70b-instruct # or openai/gpt-4, anthropic/claude-3-opus, google/gemini-pro, etc.
45
+
46
+ ## Ollama
47
+ # USE_OLLAMA=false
48
+ # OLLAMA_MODEL=llama3
49
+
50
+ ## OpenAI
51
+ # OPENAI_API_KEY=your_openai_api_key
52
+ # OPENAI_MODEL=gpt-4o
53
 
54
  # Application Settings
55
+ DEFAULT_PERSONA="Motivational Coach"
56
  TEMPERATURE=0.7
57
  MAX_TURNS=10
58
  ```
 
70
  ## πŸ› οΈ Tech Stack
71
 
72
  - **UI**: Gradio
73
+ - **Primary Backend**: OpenRouter (with support for 100+ models)
74
+ - **Alternative Backends**: OpenAI API, Ollama
75
  - **Language**: Python 3.8+
76
  - **Configuration**: Environment variables via python-dotenv
77
+ - **Dependencies**: openai, gradio, python-dotenv, requests
huggingface.yaml ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ sdk: gradio
2
+ app_file: app.py
3
+ python_version: 3.13