Create README.md

README.md

@@ -0,0 +1,31 @@
+# Model Card for environmental-claims
+### Model Description
+The environmental-claims model is fine-tuned using the EnvironmentalClaims dataset on Bert base-uncased model. This model is fine-tuned with the help of Happy Transformers on the Bert base-uncased model. The EnvironmentalClaims dataset is annotated by finance and sustainable finance students and authors of Zurich University. This model is expected to predict whether the input sequence is related to real-time environmental claims or not. 
+
+# Model Card Meta data
+---
+Language: 
+  - English
+thumbnail: "url to a thumbnail used in social sharing"
+tags:
+- https://huggingface.co/bert-base-uncased
+- https://huggingface.co/climatebert/environmental-claims
+datasets:
+- https://huggingface.co/datasets/climatebert/environmental_claims
+---
+
+
+# Usage
+loading the model :
+from happytransformer import HappyTextClassification
+happy_class = HappyTextClassification(model_type="BERT", model_name="Vinoth24/environmental_claims")
+
+prediction :
+result = happy_class.classify_text('The reduction of carbon emissions is improving for the last 2 years.')
+print(result) -- TextClassificationResult(label='LABEL_1', score=0.9948860359191895)
+print(result.label) -- LABEL_1
+print(result.score) -- 0.994
+
+Feel free to train the model more with your custom Environmental claims data. Any queries will be answered. Thank you! :)
+
+Created by Kasi Vinoth S from India