BercyHub commited on
Commit
28ecda3
1 Parent(s): 3a1171f

feat(model card) : create new model card

Browse files
Files changed (1) hide show
  1. README.md +127 -0
README.md CHANGED
@@ -1,3 +1,130 @@
1
  ---
2
  license: mit
 
 
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: mit
3
+ language:
4
+ - fr
5
+ tags:
6
+ - classification
7
+ - discussions
8
+ - catégorisation
9
+ - inference
10
+ - camembert
11
+ - NLP
12
+ base-model:
13
+ - camembert-base
14
  ---
15
+ # Model Card for Model ID
16
+
17
+ <!-- Provide a quick summary of what the model is/does. -->
18
+
19
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
20
+
21
+ ## Model Details
22
+
23
+ ### Model Description
24
+
25
+ <!-- Provide a longer summary of what this model is. -->
26
+
27
+
28
+
29
+ - **Developed by:** [More Information Needed]
30
+ - **Funded by [optional]:** [More Information Needed]
31
+ - **Shared by [optional]:** [More Information Needed]
32
+ - **Model type:** [More Information Needed]
33
+ - **Language(s) (NLP):** [More Information Needed]
34
+ - **License:** [More Information Needed]
35
+ - **Finetuned from model [optional]:** [More Information Needed]
36
+
37
+ ### Model Sources [optional]
38
+
39
+ <!-- Provide the basic links for the model. -->
40
+
41
+ - **Repository:** [More Information Needed]
42
+ - **Paper [optional]:** [More Information Needed]
43
+ - **Demo [optional]:** [More Information Needed]
44
+
45
+ ## Uses
46
+
47
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
48
+
49
+ ### Direct Use
50
+
51
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
52
+
53
+ [More Information Needed]
54
+
55
+
56
+ ### Recommendations
57
+
58
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
59
+
60
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
61
+
62
+ ## How to Get Started with the Model
63
+
64
+ Use the code below to get started with the model.
65
+
66
+ [More Information Needed]
67
+
68
+ ## Training Details
69
+
70
+ ### Training Data
71
+
72
+ Jeu de données annoté par Datactivist, disponible sur data.gouv.fr : https://www.data.gouv.fr/fr/datasets/annotation-des-discussions-publiees-sur-data-gouv-fr/#/resources
73
+ (voir fichier : "discussions-annotations-public-.csv")
74
+
75
+ ### Training Procedure
76
+
77
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
78
+
79
+ #### Preprocessing [optional]
80
+
81
+ [More Information Needed]
82
+
83
+
84
+ #### Training Hyperparameters
85
+
86
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
87
+
88
+ ## Evaluation
89
+
90
+ <!-- This section describes the evaluation protocols and provides the results. -->
91
+
92
+ ### Testing Data, Factors & Metrics
93
+
94
+ #### Testing Data
95
+
96
+ <!-- This should link to a Dataset Card if possible. -->
97
+
98
+ [More Information Needed]
99
+
100
+ #### Metrics
101
+
102
+ - Accuracy
103
+ - Recall
104
+ - Precision
105
+ - F1-score
106
+
107
+ ### Results
108
+
109
+ [More Information Needed]
110
+
111
+ #### Summary
112
+
113
+
114
+
115
+ ### Model Architecture and Objective
116
+
117
+ [More Information Needed]
118
+
119
+ ### Compute Infrastructure
120
+
121
+ [More Information Needed]
122
+
123
+
124
+ ## Model Card Authors
125
+
126
+ Asma RACHIDI (BercyHub)
127
+
128
+ ## Model Card Contact
129
+
130