docs: add MIT license (inherited from CamemBERT), base_model + metadata per HF guidelines

README.md

@@ -1,11 +1,17 @@
 ---
-language: fr
+language:
+  - fr
+license: mit
+library_name: transformers
+pipeline_tag: text-classification
 tags:
   - text-classification
   - financial-sentiment-analysis
   - sentiment-analysis
+  - camembert
+base_model: camembert-base
 datasets:
-  - datasets/financial_phrasebank
+  - financial_phrasebank
 metrics:
   - f1
   - accuracy
@@ -18,6 +24,28 @@ widget:
     example_title: "Example 2"
   - text: "Les actions de CDPROJEKT ont enregistré la plus forte baisse parmi les entreprises cotées au WSE."
     example_title: "Example 3"
+model-index:
+  - name: finance-sentiment-fr-base
+    results:
+      - task:
+          type: text-classification
+          name: Financial Sentiment Analysis
+        dataset:
+          name: Financial PhraseBank (translated to French)
+          type: financial_phrasebank
+        metrics:
+          - type: f1
+            value: 0.963
+            name: F1 (macro)
+          - type: precision
+            value: 0.959
+            name: Precision (macro)
+          - type: recall
+            value: 0.967
+            name: Recall (macro)
+          - type: accuracy
+            value: 0.971
+            name: Accuracy
 ---
 
 
@@ -55,6 +83,12 @@ nlp("Le chiffre d'affaires net a augmenté de 30 % pour atteindre 36 millions d'
 ## Changelog
 - 2023-09-18: Initial release
 
+## License
+
+This model is released under the **[MIT License](https://opensource.org/licenses/MIT)**, inherited from the base model [camembert-base](https://huggingface.co/camembert-base) (MIT).
+
+Attribution: CamemBERT — Inria, Facebook AI Research; Finance Sentiment FR (base) — bards.ai.
+
 ## About bards.ai
 
 At bards.ai, we focus on providing machine learning expertise and skills to our partners, particularly in the areas of nlp, machine vision and time series analysis. Our team is located in Wroclaw, Poland. Please visit our website for more information: [bards.ai](https://bards.ai/)