aadya1762 commited on
Commit
d71e3b1
·
1 Parent(s): 862cea0

update REAME

Browse files
Files changed (1) hide show
  1. README.md +35 -34
README.md CHANGED
@@ -9,59 +9,60 @@ app_file: app.py
9
  pinned: false
10
  models:
11
  - google/gemma-2b
12
- - google/gemma-2b-it
13
  - google/gemma-7b
14
- - google/gemma-7b-it
15
  tags:
16
  - gemma
17
  - chat
18
  - language-model
19
  - code-generation
20
- short_description: A chat interface for Google's Gemma models.
21
  ---
22
 
23
  # Gemma Chat Demo
24
 
25
- An interactive chat application powered by Google's Gemma models using Hugging Face and Streamlit.
26
-
27
- HuggingFace Spaces Link: https://huggingface.co/spaces/aadya1762/GemmaDemoSt2
28
 
29
  ## Features
30
 
31
- - 🔐 Hugging Face authentication for accessing Gemma models
32
- - 🤖 Support for multiple Gemma model variants (2B, 7B, base and instruction-tuned)
33
- - 🔄 Task selection for different conversation types:
34
- - Question Answering
35
- - Text Generation
36
- - Code Completion
37
- - 💬 Clean chat interface with message history
38
- - 🧹 Option to clear chat history
 
 
 
39
 
40
- ## Usage
41
 
42
- 1. Log in with your Hugging Face token in the sidebar
43
- 2. Select your preferred Gemma model
44
- 3. Choose a task type for your conversation
45
- 4. Start chatting with the model!
46
 
47
- ## Requirements
 
 
 
48
 
49
- - Python 3.12
50
- - Hugging Face account with access to Gemma models
51
- - Dependencies listed in requirements.txt
 
52
 
53
- ## Running Locally
54
 
55
- ```bash
56
- # Install dependencies
57
- pip install -r requirements.txt
58
 
59
- # Run the application
60
- python app.py
61
- ```
62
 
63
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
64
 
65
- ## Limitations
66
- - CPU Implementation is very slow (a simple code completion can take around 10 minutes).
67
- - Limit Scope of Optimization (`torch.compile` takes several minutes to compile & recompiles frequently)
 
9
  pinned: false
10
  models:
11
  - google/gemma-2b
12
+ - google/gemma-3b
13
  - google/gemma-7b
 
14
  tags:
15
  - gemma
16
  - chat
17
  - language-model
18
  - code-generation
19
+ short_description: A friendly chat interface for Google's Gemma models.
20
  ---
21
 
22
  # Gemma Chat Demo
23
 
24
+ A simple and friendly chat application powered by Google's Gemma AI models.
 
 
25
 
26
  ## Features
27
 
28
+ - 💬 Chat with Google's Gemma AI models right on your computer
29
+ - 🔄 Choose between different models:
30
+ - gemma-3b: Balanced performance (recommended)
31
+ - gemma-2b: Faster responses
32
+ - gemma-7b: More capable but requires more resources
33
+ - 🧩 Different chat modes:
34
+ - Question Answering: Get helpful answers to your questions
35
+ - Text Generation: Continue any text or story
36
+ - Code Completion: Get help with coding
37
+ - 🖥️ Simple, easy-to-use interface
38
+ - 📚 No complex setup needed
39
 
40
+ ## Getting Started
41
 
42
+ 1. Install the required packages:
43
+ ```
44
+ pip install -r requirements.txt
45
+ ```
46
 
47
+ 2. Run the application:
48
+ ```
49
+ python app.py
50
+ ```
51
 
52
+ 3. When the application starts:
53
+ - Select a model from the dropdown
54
+ - Choose a chat mode
55
+ - Start typing and chatting!
56
 
57
+ ## Requirements
58
 
59
+ - Python 3.11 or newer
60
+ - Internet connection for first-time model download
 
61
 
62
+ ## Tips
 
 
63
 
64
+ - For code completion, start by typing the beginning of your code
65
+ - The first time you select a model, it may take a moment to download
66
+ - You can switch between models anytime during your conversation
67
 
68
+ Enjoy chatting with Gemma!