Upload README.md with huggingface_hub

README.md

@@ -1,6 +1,19 @@
 ---
-library_name: transformers
-tags: []
+base_model: FacebookAI/roberta-large
+language: en
+license: apache-2.0
+model_name: climate-mitigation-classifier
+pipeline_tag: text-classification
+tags:
+- CRS
+- OECD CRS
+- text-classification
+- lora
+- transformers
+funded_by: DEval - Deutsches Evaluierungsinstitut der Entwicklungszusammenarbeit gGmbH
+tasks:
+- text-classification
+shared_by: DEval - Deutsches Evaluierungsinstitut der Entwicklungszusammenarbeit gGmbH
 ---
 
 # Model Card for Model ID
@@ -15,15 +28,58 @@ tags: []
 
 <!-- Provide a longer summary of what this model is. -->
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+### Model description 
+
+This model identifies the relevance of CRS projects to climate-change mitigation. It is trained on manually annotated CRS data using the standard Rio Marker classification. Labels 0, 1, and 2 indicate whether a project has no, significant, or primary focus on climate-change mitigation. (RIO Marker)
+
+ ### Evaluation metrics 
+
+ | |precision|recall|f1-score|support|
+|--|--|--|--|--|
+|0|0.87|0.91|0.89|311|
+|1|0.53|0.60|0.57|65|
+|2|0.76|0.79|0.78|87|
+|3|0.52|0.25|0.34|51|
+|--|--|--|--|--|
+|accuracy| | |0.78|514|
+|macro|avg|0.67|0.64|0.64|514|
+|weighted|avg|0.77|0.78|0.77|514|
+
+
+ ### Usage 
+
+ ```python## How to Use
+
+```python 
+from transformers import AutoModelForSequenceClassification, AutoTokenizer
+
+model = AutoModelForSequenceClassification.from_pretrained("namespace/my-model")
+tokenizer = AutoTokenizer.from_pretrained("namespace/my-model")
+
+inputs = tokenizer("hello world", return_tensors="pt")
+outputs = model(**inputs)
+print(outputs)"
+```
+or
+
+```python 
+from transformers import TextClassificationPipeline
+
+model = TextClassificationPipeline("namespace/my-model")
+outputs = model("Hello World!")
+print(outputs)"
+```
+```
+
+
 
 - **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
+- **Funded by [optional]:** DEval - Deutsches Evaluierungsinstitut der Entwicklungszusammenarbeit gGmbH
+- **Shared by [optional]:** DEval - Deutsches Evaluierungsinstitut der Entwicklungszusammenarbeit gGmbH
 - **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Language(s) (NLP):** en
+- **License:** apache-2.0
+- **Finetuned from model [optional]:** FacebookAI/roberta-large
 
 ### Model Sources [optional]