Clemylia commited on
Commit
fe90b04
·
verified ·
1 Parent(s): 989f5c9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +54 -162
README.md CHANGED
@@ -2,198 +2,90 @@
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]
 
2
  library_name: transformers
3
  tags: []
4
  ---
5
+ # মডেল Carte de Modèle : Lamina-basic
6
 
7
+ ![Lamina-basic](http://www.image-heberg.fr/files/17584565541229573219.jpg)
8
 
9
+ Bienvenue sur la page de **Lamina-basic** \! Ce modèle est un projet expérimental et éducatif créé dans le but d'apprendre les fondamentaux de la création et de l'entraînement d'un modèle de langage (LLM) en partant de zéro.
10
 
11
+ Il a été conçu, entraîné et publié par **Clemylia**.
12
 
13
+ -----
14
 
15
+ \<hr\>
16
 
17
+ ## \#\# 📝 Description du Modèle
18
 
19
+ **Lamina-basic** est un petit modèle de langage de type GPT-2, avec une architecture simple de 3 millions de paramètres. Son unique compétence est la **complétion de texte** en français. Il a été entraîné sur un corpus très restreint, ce qui en fait principalement un outil de démonstration et d'apprentissage.
20
 
21
+ * **🤖 Type de modèle :** Modèle de langage causal (Causal Language Model)
22
+ * **🌐 Langue :** Français
23
+ * **📚 Données d'entraînement :** Un micro-dataset personnalisé contenant des règles de grammaire de base et quelques paragraphes de connaissances générales (biologie des insectes, faits de base).
24
+ * **💻 Entraînement :** Entraîné depuis zéro ("from scratch") sur Google Colab.
25
 
26
+ -----
 
 
 
 
 
 
27
 
28
+ \<hr\>
29
 
30
+ ## \#\# 🚀 Comment l'utiliser
31
 
32
+ Pour tester `Lamina-basic`, vous pouvez utiliser le `pipeline` de la bibliothèque `transformers`.
 
 
33
 
34
+ ```python
35
+ # 1. Installez les bibliothèques nécessaires
36
+ !pip install transformers torch
37
 
38
+ from transformers import AutoTokenizer, pipeline
39
 
40
+ # 2. Définissez le nom du modèle sur le Hub
41
+ repo_id = "Clemylia/Lamina-basic"
42
 
43
+ # 3. Créez le pipeline de génération de texte
44
+ generator = pipeline('text-generation', model=repo_id, tokenizer=repo_id)
45
 
46
+ # 4. Donnez un début de phrase au modèle
47
+ prompt = "La biologie des insectes est"
48
 
49
+ # 5. Générez la suite !
50
+ result = generator(
51
+ prompt,
52
+ max_new_tokens=30, # Génère au maximum 30 nouveaux mots
53
+ truncation=True
54
+ )
55
 
56
+ print(result[0]['generated_text'])
57
+ ```
58
 
59
+ -----
60
 
61
+ \<hr\>
62
 
63
+ ## \#\# Usages Prévus et ⚠️ Limitations
64
 
65
+ Il est crucial de comprendre que `Lamina-basic` est un prototype avec des capacités extrêmement limitées.
66
 
67
+ ### \#\#\# Usages Prévus
68
 
69
+ * **Démonstration Pédagogique :** Montrer le résultat d'un cycle complet de création d'un LLM.
70
+ * **Apprentissage :** Servir de base pour comprendre comment fonctionnent les modèles de langage.
71
+ * **Expérimentation :** Être un point de départ pour une V2 avec plus de données et une plus grande architecture.
72
 
73
+ ### \#\#\# ⚠️ Limitations et Risques
74
 
75
+ * **Génération de texte non cohérente :** En raison de son entraînement très limité, les phrases générées n'ont souvent **aucun sens logique**.
76
+ * **Connaissances quasi-nulles :** Le modèle ne connaît que les quelques phrases exactes présentes dans son micro-dataset. Il ne possède aucune connaissance du monde réel.
77
+ * **Biais potentiels :** Comme tout modèle de langage, il peut reproduire les biais présents dans ses données d'entraînement. Étant donné la petite taille du dataset, ces biais ne sont pas étudiés.
78
 
79
+ -----
80
 
81
+ \<hr\>
82
 
83
+ ## \#\# Un mot de la créatrice
84
 
85
+ > "Lamina-basic est mon premier pas dans la création d'IA de A à Z. Ce projet représente une aventure d'apprentissage incroyable, des premières lignes de code à la résolution de bugs complexes. Même s'il est simple, j'espère qu'il pourra inspirer d'autres personnes à se lancer et à construire leurs propres modèles."
86
+ >
87
+ > — Clemylia
88
 
89
+ <br>
90
 
91
+ *Créé avec passion par Clemylia. ❤️*