Update README.md

README.md

@@ -29,6 +29,7 @@ It classifies English-language text into **Positive**, **Negative** or **Neutral
 - **License:** MIT
 - **Finetuned from:** [ProsusAI/finbert](https://huggingface.co/ProsusAI/finbert)
 
+<!-- 
 ### Model Sources [optional] TO DO
 
 <!-- Provide the basic links for the model. -->
@@ -48,9 +49,7 @@ It classifies English-language text into **Positive**, **Negative** or **Neutral
 - Sentiment classification of news articles and headlines, regulatory filings, or analyst notes discussing **tariffs, trade wars, or import/export policy**.
 - Can be used as-is via the Hugging Face `pipeline("text-classification")`.
 
-
-
-### Downstream Use [optional]
+### Downstream Use
 
 <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
@@ -82,11 +81,22 @@ Users (both direct and downstream) should be made aware of the risks, biases and
 
 **Use confidence thresholds and human review in production.**
 
-## How to Get Started with the Model TO DO
+## How to Get Started with the Model
 
 Use the code below to get started with the model.
+```{python}
+from transformers import pipeline
 
-[More Information Needed]
+pipe = pipeline("text-classification", model="CristobalMe/TariffBERT")
+
+text = "This is an example text for classification."
+
+result = pipe(text)
+
+print(result)
+```
+
+<!-- TO DO
 
 ## Training Details TO DO
 
@@ -94,12 +104,14 @@ Use the code below to get started with the model.
 
 <!-- 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. -->
 
+<!--
 [More Information Needed]
 
 ### Training Procedure
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
+<!--
 #### Preprocessing [optional]
 
 [More Information Needed]
@@ -108,50 +120,36 @@ Use the code below to get started with the model.
 #### 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]
 
+-->
+
+<!-- 
 ## Evaluation
 
 <!-- This section describes the evaluation protocols and provides the results. -->
 
+<!-- 
 ### Testing Data, Factors & Metrics
 
 #### Testing Data
 
 <!-- This should link to a Dataset Card if possible. -->
 
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
 #### Metrics
 
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
+Accuracy
 
 ### Results
 
-[More Information Needed]
-
-#### Summary
-
-
+Accuracy: 0.9
 
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
 
 ## Environmental Impact
 
@@ -162,28 +160,13 @@ Use the code below to get started with the model.
 - **Energy Use Estimate:** ≈0.02 kWh  
 - **Estimated Carbon Emissions:** ≈0.01 kg CO2eq  
 
-## 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]
@@ -191,22 +174,10 @@ Use the code below to get started with the model.
 **APA:**
 
 [More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
+-->
 
 ## Model Card Contact
 
 For questions or collaboration, email [hello@cmm.fyi](hello@cmm.fyi)
+
 Or contact [@CristobalMe](https://github.com/CristobalMe)