pablo-rf commited on
Commit
959d19d
1 Parent(s): 2e8dc47

[ADD] Tools, Framework License and Citation Information sections

Browse files
Files changed (1) hide show
  1. README.md +27 -13
README.md CHANGED
@@ -34,25 +34,25 @@ widget:
34
  - [Intended uses and limitations](#intended-uses-and-limitations)
35
  - [How to use](#how-to-use)
36
  - [Training](#training)
37
- - [Platform](#platform)
38
  - [Language adaptation and training](#language-adaptation-and-training)
39
  - [Training data](#training-data)
40
  - [Training hyperparameters](#training-hyperparameters)
41
  - [Framework](#framework)
42
  - [Evaluation](#evaluation)
43
  - [Additional information](#additional-information)
44
- - [Author](#author)
45
  - [Contact](#contact)
46
  - [Copyright](#copyright)
47
  - [License](#license)
48
  - [Funding](#funding)
 
49
 
50
  </details>
51
 
52
  ## Model description
53
 
54
  **FLOR-1.3B-GL** is a 1.3B-parameter transformer-based causal language model for Galician.
55
- It is the result of continual pretraining of [FLOR-1.3B](https://huggingface.co/projecte-aina/FLOR-1.3B) with the galician corpus [CorpusNos]().
56
 
57
  ## Intended uses and limitations
58
 
@@ -89,9 +89,9 @@ print(f"Result: {generation[0]['generated_text']}")
89
 
90
  ## Training
91
 
92
- ### Platform
93
 
94
- HF Tranformers + run_clm.py
95
 
96
  ### Language adaptation and training
97
 
@@ -104,6 +104,7 @@ The language adaptation technique used to train FLOR-1.3B-GL is based in the use
104
 
105
  ### Training data
106
 
 
107
 
108
 
109
 
@@ -121,18 +122,15 @@ The language adaptation technique used to train FLOR-1.3B-GL is based in the use
121
  - scheduler: "Linear"
122
  - learning_rate: 5e-05
123
  - num_epochs: 1.2
124
- -
125
  ### Framework
126
- CESGA, 1 node with 5GPUs A100
127
 
128
  ## Evaluation
129
-
130
 
131
  ## Additional information
132
 
133
- ### Author
134
-
135
-
136
  ### Contact
137
 
138
 
@@ -140,7 +138,23 @@ CESGA, 1 node with 5GPUs A100
140
 
141
 
142
  ### License
143
- [MIT]()
 
 
 
 
 
 
 
 
144
 
145
  ### Funding
146
- This research was funded by “The Nós project: Galician in the society and economy of Artificial Intelligence”, resulting from the agreement 2021-CP080 between the Xunta de Galicia and the University of Santiago de Compostela, and thanks to the Investigo program, within the National Recovery, Transformation and Resilience Plan, within the framework of the European Recovery Fund (NextGenerationEU).
 
 
 
 
 
 
 
 
 
34
  - [Intended uses and limitations](#intended-uses-and-limitations)
35
  - [How to use](#how-to-use)
36
  - [Training](#training)
37
+ - [Tools](#tools)
38
  - [Language adaptation and training](#language-adaptation-and-training)
39
  - [Training data](#training-data)
40
  - [Training hyperparameters](#training-hyperparameters)
41
  - [Framework](#framework)
42
  - [Evaluation](#evaluation)
43
  - [Additional information](#additional-information)
 
44
  - [Contact](#contact)
45
  - [Copyright](#copyright)
46
  - [License](#license)
47
  - [Funding](#funding)
48
+ - [Citation information](#citation-information)
49
 
50
  </details>
51
 
52
  ## Model description
53
 
54
  **FLOR-1.3B-GL** is a 1.3B-parameter transformer-based causal language model for Galician.
55
+ It is the result of a continual pretraining of [FLOR-1.3B](https://huggingface.co/projecte-aina/FLOR-1.3B) (based in [BLOOM-1.7B](https://huggingface.co/bigscience/bloom-1b7)) with the galician corpus [CorpusNos]().
56
 
57
  ## Intended uses and limitations
58
 
 
89
 
90
  ## Training
91
 
92
+ ### Tools
93
 
94
+ It was trained using HuggingFace Transformers and Pytorch, using the [Causal Modeling Language script](https://github.com/huggingface/transformers/blob/main/examples/pytorch/language-modeling/run_clm.py)
95
 
96
  ### Language adaptation and training
97
 
 
104
 
105
  ### Training data
106
 
107
+ CorpusNos (describir) Citar paper? Zenodo?
108
 
109
 
110
 
 
122
  - scheduler: "Linear"
123
  - learning_rate: 5e-05
124
  - num_epochs: 1.2
125
+
126
  ### Framework
127
+ The traininf was conducted in the Galicia Supercomputing Center ([CESGA](https://www.cesga.es/en/home-2/)), using 1 node with 5 GPUs NVIDIA A100.
128
 
129
  ## Evaluation
130
+ Human evaluation? Include automatic metrics? (bertscore, perplexity)
131
 
132
  ## Additional information
133
 
 
 
 
134
  ### Contact
135
 
136
 
 
138
 
139
 
140
  ### License
141
+ MIT License
142
+
143
+ Copyright (c) 2024 Proxecto Nós
144
+
145
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
146
+
147
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
148
+
149
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
150
 
151
  ### Funding
152
+ This research was funded by “The Nós project: Galician in the society and economy of Artificial Intelligence”, resulting from the agreement 2021-CP080 between the Xunta de Galicia and the University of Santiago de Compostela, and thanks to the Investigo program, within the National Recovery, Transformation and Resilience Plan, within the framework of the European Recovery Fund (NextGenerationEU).
153
+
154
+ ## Citation information
155
+
156
+ If you use this model, please cite as follows:
157
+
158
+ AUTHORS
159
+ URL: https://huggingface.co/proxectonos/FLOR-1.3B-GL
160
+