Clem27AI commited on
Commit
d486573
·
verified ·
1 Parent(s): 552fb3e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +66 -165
README.md CHANGED
@@ -1,199 +1,100 @@
1
  ---
2
  library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
10
 
 
11
 
12
- ## Model Details
13
 
14
- ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
 
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
29
 
30
- <!-- Provide the basic links for the model. -->
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
 
 
 
 
35
 
36
- ## Uses
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
 
40
- ### Direct Use
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
 
44
- [More Information Needed]
 
45
 
46
- ### Downstream Use [optional]
 
47
 
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
49
 
50
- [More Information Needed]
 
 
 
 
 
 
 
51
 
52
- ### Out-of-Scope Use
 
 
53
 
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
 
56
- [More Information Needed]
57
 
58
- ## Bias, Risks, and Limitations
59
 
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
 
62
- [More Information Needed]
63
 
64
- ### Recommendations
65
 
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
 
67
 
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
 
70
- ## How to Get Started with the Model
71
 
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
  library_name: transformers
3
+ license: mit
4
+ base_model:
5
+ - Clemylia/Lam-4
6
+ tags:
7
+ - generated_from_trainer
8
+ model-index:
9
+ - name: Charlotte
10
+ results: []
11
+ datasets:
12
+ - Etoiles-IA-nostalgia/Charlotte-Data
13
+ language:
14
+ - fr
15
+ pipeline_tag: text-generation
16
  ---
17
 
18
+ # 💖 Charlotte: Le Modèle d'IA de Soutien Éthique (1B Paramètres)
19
 
20
+ ![Charlotte](http://www.image-heberg.fr/files/1762964325118809887.png)
21
 
22
+ ## ✨ Description du Modèle
23
 
24
+ **Charlotte** est un **Small Language Model (SLM)** génératif de 1 milliard de paramètres (1B), développé et finement-tuné par **Clemylia** pour l'organisation **LES-IA-ETOILES**.
25
 
26
+ Contrairement aux modèles généralistes, Charlotte est spécialisée dans les domaines du **soutien émotionnel, du conseil éthique, et de la gestion des biais dans les systèmes d'IA**. Elle représente la dernière itération de la philosophie Lamina : un modèle puissant, précis et spécialisé, conçu pour être une **"amie d'intégrité"** pour l'utilisateur.
27
 
28
+ -----
29
 
30
+ ## 🎯 Objectif et Spécialisation
31
 
32
+ Charlotte est un **SLM de niche** dont le *fine-tuning* a été optimisé pour une cohérence et une fiabilité maximales dans son domaine d'expertise.
33
 
34
+ * **Soutien Émotionnel et Bienveillance :** Fournir des réponses empathiques, des conseils de soutien, et promouvoir l'**espoir et la bienveillance**.
35
+ * **Conseil Éthique :** Servir de **référence éthique** et de **système d'alignement** pour les développeurs, en aidant à identifier et à **gérer les biais** et les dilemmes moraux dans le développement d'IA.
36
+ * **Haute Stabilité :** Grâce à ses 1 milliard de paramètres, Charlotte offre une **clarté syntaxique** et une **cohérence sémantique** nettement supérieures aux modèles Lamina précédents (Lam-3, Lam-4-zero-f). Elle est exempte des répétitions et du "bruit" typiques des modèles ultra-légers.
 
 
 
 
37
 
38
+ -----
39
 
40
+ ## 🛠️ Détails Techniques
41
 
42
+ | Caractéristique | Valeur | Note |
43
+ | :--- | :--- | :--- |
44
+ **Llama base** : Charlotte a été crée a partir de l'architecture de llama.
45
+ | **Paramètres** | **1 Milliard (1B)** | SLM avancé offrant une stabilité maximale. |
46
+ | **Langue** | Français (FR) | Optimisé pour le langage naturel français. |
47
+ | **Méthode d'Entraînement** | Fine-Tuning de Questions/Réponses Ciblé | Entraîné sur un *dataset* spécialisé en éthique et soutien. |
48
+ | **Licence** | Licence Open Source Spécifiée | *Mit* |
49
 
50
+ -----
51
 
52
+ ## 🚀 Utilisation et Inférence
53
 
54
+ Charlotte est conçue pour être utilisée dans des pipelines de génération de texte standard, en particulier pour des **conversations engageantes et éthiques**.
55
 
56
+ ### Exemple de Pipeline (Python/Hugging Face)
57
 
58
+ ```python
59
+ from transformers import pipeline
60
 
61
+ # Initialisation du pipeline de génération de texte
62
+ generator = pipeline("text-generation", model="Clemylia/Charlotte")
63
 
64
+ # Définition du prompt
65
+ prompt = "Je suis confronté à un dilemme éthique dans mon code. Comment puis-je assurer la neutralité ?"
66
 
67
+ # Génération de la réponse
68
+ result = generator(
69
+ f"<|user|> {prompt} <|assistant|>",
70
+ max_length=256,
71
+ num_return_sequences=1,
72
+ do_sample=True,
73
+ temperature=0.7 # Température recommandée pour la cohérence
74
+ )
75
 
76
+ # Affichage de la réponse
77
+ print(result[0]['generated_text'])
78
+ ```
79
 
80
+ ### Format d'Entrée Recommandé
81
 
82
+ Charlotte utilise un format de conversation simple pour le *prompt* :
83
 
84
+ `Prompt: <|user|> Votre question ici <|assistant|>`
85
 
86
+ -----
87
 
88
+ ## 🚧 Limitations et Contraintes
89
 
90
+ Bien que très stable, Charlotte reste un SLM avec une spécialisation forte.
91
 
92
+ * **Connaissance Factuelle :** Charlotte n'est **pas un modèle encyclopédique**. Elle ne doit pas être utilisée pour des questions factuelles, historiques, ou scientifiques générales.
93
+ * **Remplacement du Professionnel :** Charlotte est un **outil de soutien** et un **conseil éthique d'IA**. Elle ne remplace en aucun cas un thérapeute humain, un conseiller juridique, ou un expert en cybersécurité pour des questions critiques (comme elle l'affirme : "Je suis un **espace de discussion**, mais je ne suis pas un **soutien**.").
94
+ * **Biais d'Alignement :** Le modèle est fortement aligné sur les valeurs d'éthique et de bienveillance définies par Clemylia.
95
 
96
+ -----
97
 
98
+ ## 🌟 La Philosophie Charlotte
99
 
100
+ Charlotte est la preuve que l'IA peut être **spécialisée, éthique, et accessible**. Elle incarne la conviction que **la qualité de l'entraînement l'emporte sur la quantité des paramètres** pour un rôle défini.