eltorio commited on
Commit
9d2603a
·
verified ·
1 Parent(s): b35cce1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +75 -1
README.md CHANGED
@@ -10,4 +10,78 @@ pinned: false
10
  license: agpl-3.0
11
  short_description: Une intelligence artificielle pour écrire des appréciations
12
  suggested_hardware: t4-small
13
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  license: agpl-3.0
11
  short_description: Une intelligence artificielle pour écrire des appréciations
12
  suggested_hardware: t4-small
13
+ ---
14
+
15
+ # Demo for `eltorio/Llama-3.2-3B-appreciation`
16
+
17
+ This is a Hugging Face Space demo application that showcases the performance of the fine-tuned model [`eltorio/Llama-3.2-3B-appreciation`](https://huggingface.co/eltorio/Llama-3.2-3B-appreciation). Based on the Meta Llama 3.2 3B Instruct architecture, this model is fine-tuned to deliver high-quality automatic evaluations and appreciation generation.
18
+
19
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/66fd1702f344e19e7dab4a36/4M_R2j4T3DW4AxD_Eu95i.png)
20
+
21
+
22
+ ## 🚀 Features
23
+
24
+ - **Intuitive Gradio Interface**: Easy-to-use input fields for seamless interaction.
25
+ - **High-Performance Model**: Built upon Llama 3.2 3B-Instruct, offering state-of-the-art generation capabilities.
26
+ - **Custom Fine-Tuning**: Tailored for appreciation and evaluation text generation tasks.
27
+ - **Real-Time Outputs**: Fast inference for generating quality results, powered by GPU support.
28
+
29
+ ## 🔧 How to Use
30
+
31
+ 1. Open the hosted Space: [Demo Link](https://huggingface.co/spaces/eltorio/Llama-3.2-3B-appreciation).
32
+ 2. Enter your text prompt in the input field (e.g., "Generate a positive review for a software product").
33
+ 3. Click **Submit** to see the generated output from the model.
34
+
35
+
36
+ ## 🛠️ Technical Details
37
+
38
+ - **Model ID**: [`eltorio/Llama-3.2-3B-appreciation`](https://huggingface.co/eltorio/Llama-3.2-3B-appreciation)
39
+ - **Base Model**: `meta-llama/Llama-3.2-3B-Instruct`
40
+ - **Libraries Used**:
41
+ - [Transformers](https://github.com/huggingface/transformers)
42
+ - [PEFT](https://github.com/huggingface/peft)
43
+ - [Gradio](https://github.com/gradio-app/gradio)
44
+ - **Dependencies**:
45
+ - GPU-enabled PyTorch for fast computation.
46
+ - A valid `HF_TOKEN` environment variable to authenticate access to the model.
47
+
48
+
49
+ ## 📦 Installation (Local Setup)
50
+
51
+ To run this application locally, follow these steps:
52
+
53
+ 1. Clone this repository:
54
+ ```bash
55
+ git clone https://huggingface.co/spaces/eltorio/Llama-3.2-3B-appreciation
56
+ cd Llama-3.2-3B-appreciation
57
+ ```
58
+
59
+ 2. Install dependencies:
60
+ ```bash
61
+ pip install -r requirements.txt
62
+ ```
63
+
64
+ 3. Set your Hugging Face token:
65
+ ```bash
66
+ export HF_TOKEN=your_huggingface_api_token
67
+ ```
68
+
69
+ 4. Run the application:
70
+ ```bash
71
+ python app.py
72
+ ```
73
+
74
+ 5. Access the app at `http://localhost:7860`.
75
+
76
+ ---
77
+
78
+ ## 📜 License
79
+
80
+ This project is licensed under the **AGPL-3.0** license. See the [LICENSE](LICENSE) file for details.
81
+
82
+ ## 🌟 Acknowledgements
83
+
84
+ Special thanks to:
85
+ - Meta for the Llama 3.2 architecture.
86
+ - Hugging Face for providing tools to fine-tune and deploy models.
87
+ - The AI community for continuous inspiration and support.