Update README.md

README.md

@@ -31,49 +31,41 @@ This model analyses the input text and provides an answer whether in the text th
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** N/A
+- **Paper [optional]:** N/A
+- **Demo [optional]:** N/A
 
 ## Uses
 
 <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+The model should be used giving a short paragraph of text in Italian as input 
+about which it is requested to get an answer about whether or not it contains a change of topic.
 
 ### Direct Use
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
+TBA
 
 ### Out-of-Scope Use
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
+The model should not be used as a general purpose topic change detector, i.e. on text which is not originated from news programme transcription or siilar content.
+
 
 ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+The training dataset is made up of automatic transcriptions from RAI Italian newscasts, therefore there is an intrinsic bias in the kind
+of topics that can be tracked for change.
 
 ## How to Get Started with the Model
 
 Use the code below to get started with the model.
 
-[More Information Needed]
+TBA
 
 ## Training Details
 
@@ -81,7 +73,7 @@ Use the code below to get started with the model.
 
 <!-- This should link to a Data 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. -->
 
-[More Information Needed]
+TBA
 
 ### Training Procedure 
 
@@ -89,22 +81,17 @@ Use the code below to get started with the model.
 
 #### Preprocessing [optional]
 
-[More Information Needed]
+TBA
 
 
 #### Training Hyperparameters
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
+- **Training regime:** Mixed Precision 
 
 ## Evaluation
 
 <!-- This section describes the evaluation protocols and provides the results. -->
+TBA
 
 ### Testing Data, Factors & Metrics
 
@@ -112,33 +99,21 @@ Use the code below to get started with the model.
 
 <!-- This should link to a Data Card if possible. -->
 
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
+TBA
 
 #### Metrics
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
+TBA
 
 ### Results
 
-[More Information Needed]
+TBA
 
 #### Summary
 
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
+TBA
 
 ## Environmental Impact
 
@@ -146,58 +121,27 @@ Use the code below to get started with the model.
 
 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).
 
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
+- **Hardware Type:** 2 NVIDIA A100/40Gb
+- **Hours used:** 2
+- **Cloud Provider:** Private Infrastructure
+- **Carbon Emitted:** 0.22 kg CO2 eq.
 
 ## Glossary [optional]
 
 <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
-[More Information Needed]
+TBA
 
 ## More Information [optional]
 
-[More Information Needed]
+TBA
 
 ## Model Card Authors [optional]
 
-[More Information Needed]
+Alberto Messina
 
 ## Model Card Contact
 
-[More Information Needed]
+[email protected]