docs: add CC BY 4.0 license (inherited from HerBERT), base_model + metadata per HF guidelines

README.md

@@ -1,10 +1,18 @@
 ---
-language: pl
+language:
+  - pl
+license: cc-by-4.0
+library_name: transformers
+pipeline_tag: text-classification
 tags:
   - text-classification
   - twitter
+  - emotion
+  - polish
+  - herbert
+base_model: allegro/herbert-base-cased
 datasets:
-  - datasets/tweet_eval
+  - tweet_eval
 metrics:
   - f1
   - accuracy
@@ -15,6 +23,28 @@ widget:
     example_title: "Example 1"
   - text: "Osoby z Ukrainy zapłacą za życie w centrach pomocy? Sprzeczne prawem UE, niehumanitarne, okrutne."
     example_title: "Example 2"
+model-index:
+  - name: twitter-emotion-pl-base
+    results:
+      - task:
+          type: text-classification
+          name: Emotion Classification
+        dataset:
+          name: TweetEval (translated to Polish)
+          type: tweet_eval
+        metrics:
+          - type: f1
+            value: 0.756
+            name: F1 (macro)
+          - type: precision
+            value: 0.767
+            name: Precision (macro)
+          - type: recall
+            value: 0.750
+            name: Recall (macro)
+          - type: accuracy
+            value: 0.789
+            name: Accuracy
 ---
 
 
@@ -52,6 +82,12 @@ nlp("Nigdy przegrana nie sprawiła mi takiej radości. Szczęście i Opatrznoś
 ## Changelog
 - 2023-07-19: Initial release
 
+## License
+
+This model is released under the **[Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/)** license, inherited from the base model [allegro/herbert-base-cased](https://huggingface.co/allegro/herbert-base-cased) (also CC BY 4.0).
+
+Attribution: HerBERT — Allegro ML Research and the Linguistic Engineering Group at the Institute of Computer Science, Polish Academy of Sciences; Twitter emotion PL (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/)