Update README.md

README.md

@@ -1,3 +1,142 @@
 ---
 license: apache-2.0
+language:
+- pl
+library_name: transformers
+tags:
+- continuously_pretrained
+inference:
+  parameters:
+    temperature: 0.7
 ---
+
+# Bielik-7B-v0.1
+
+The Bielik-7B-v0.1 is a generative text model featuring 7 billion parameters, meticulously evolved from its predecessor, the [Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1), through the processing of over 70 billion tokens. This model stands as a testament to the unique collaboration between the open-science project SpeakLeash and the High Performance Computing (HPC) center: ACK Cyfronet AGH. Developed and trained on Polish text corpora, meticulously collected and processed by the SpeakLeash team, this endeavor leverages Poland's large-scale computing infrastructure, specifically within the PLGrid environment, and more precisely, the HPC centers: ACK Cyfronet AGH. The training of the Bielik-7B-v0.1 was propelled by the support of computational grant number PLG/2024/016951, conducted on the Helios supercomputer, enabling the use of cutting-edge technology and computational resources essential large-scale machine learning processes. As a result, the model exhibits an exceptional ability to understand and process the Polish language, providing accurate responses and performing a variety of linguistic tasks with high precision.
+
+## Model
+
+Bielik-7B-v0.1 has been trained with the use of an original open source framework called [ALLaMo](https://github.com/chrisociepa/allamo) implemented by [Krzysztof Ociepa](https://www.linkedin.com/in/krzysztof-ociepa-44886550/). This framework allows users to train language models with architecture similar to LLaMA and Mistral in a fast and efficient way.
+
+The model training was conducted on the Helios Supercomputer at the ACK Cyfronet AGH, utilizing 256 GH200 cards and achieving a throughput exceeding 9200 tokens/gpu/second.
+
+The training dataset was composed of Polish texts collected and made available through the [SpeakLeash](https://speakleash.org/) project. We used over 36 billion tokens for two epochs of training.
+
+### Model description:
+
+* **Developed by:** [SpeakLeash](https://speakleash.org/)
+* **Language:** Polish
+* **Model type:** causal decoder-only
+* **Adopted from:** [Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1)
+* **License:** Apache 2.0 (commercial use allowed)
+
+### Quality evaluation
+
+A XGBoost classification model was prepared and created to evaluate the quality of texts in Polish based on 93 features, such as the ratio of out-of-vocabulary words to all words (oovs), the number of nouns, verbs, or the average sentence length etc.. The model's output indicates the category (HIGH, MEDIUM, LOW) along with the % probability, which allows for the implementation of effective filters for analyzing texts only with a high quality index (HIGH > 90%).
+
+This filtration and appropriate selection of texts enable the provision of a condensed and high-quality database of texts in Polish for training purposes.
+
+## Training
+
+* Framework: [ALLaMo](https://github.com/chrisociepa/allamo)
+* Visualizations: [W&B](https://wandb.ai)
+
+<p align="center">
+  <img src="https://huggingface.co/speakleash/Bielik-7B-v0.1/raw/main/train_loss.png">
+</p>
+<p align="center">
+  <img src="https://huggingface.co/speakleash/Bielik-7B-v0.1/raw/main/train_ppl.png">
+</p>
+<p align="center">
+  <img src="https://huggingface.co/speakleash/Bielik-7B-v0.1/raw/main/train_acc.png">
+</p>
+
+### Training hyperparameters:
+
+| **Hyperparameter**          | **Value**        |
+|-----------------------------|------------------|
+| Micro Batch Size            | 4                |
+| Batch Size                  | 4194304          |
+| Learning Rate (cosine)      | 3e-05 -> 2e-05   |
+| Warmup Iterations           | 2000             |
+| All Iterations              | 17350            |
+| Optimizer                   | AdamW            |
+| β1, β2                      | 0.9, 0.95        |
+| Adam_eps                    | 1e−8             |
+| Weight Decay                | 0.1              |
+| Grad Clip                   | 1.0              |
+| Precision                   | bfloat16 (mixed) |
+
+
+### Quickstart
+
+This model can be easily loaded using the AutoModelForCausalLM functionality.
+
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+model_name = "speakleash/Bielik-7B-v0.1"
+
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForCausalLM.from_pretrained(model_name)
+```
+
+In order to reduce the memory usage, you can use smaller precision (`bfloat16`).
+
+```python
+import torch
+
+model = AutoModelForCausalLM.from_pretrained(model_name, torch_dtype=torch.bfloat16)
+```
+
+And then you can use Hugging Face Pipelines to generate text:
+
+```python
+import transformers
+
+text = "Najważniejszym celem człowieka na ziemi jest"
+
+pipeline = transformers.pipeline("text-generation", model=model, tokenizer=tokenizer)
+sequences = pipeline(max_new_tokens=100, do_sample=True, top_k=50, eos_token_id=tokenizer.eos_token_id, text_inputs=text)
+for seq in sequences:
+    print(f"Result: {seq['generated_text']}")
+```
+Generated output:
+> Najważniejszym celem człowieka na ziemi jest życie w pokoju, harmonii i miłości. Dla każdego z nas bardzo ważne jest, aby otaczać się kochanymi osobami.
+
+## Limitations and Biases
+
+Bielik-7B-v0.1 is not intended for deployment without fine-tuning. It should not be used for human-facing interactions without further guardrails and user consent.
+
+Bielik-7B-v0.1 can produce factually incorrect output, and should not be relied on to produce factually accurate information. Bielik-7B-v0.1 was trained on various public datasets. While great efforts have been taken to clear the pretraining data, it is possible that this model can generate lewd, false, biased or otherwise offensive outputs.
+
+## License
+
+The model is licensed under Apache 2.0, which allows for commercial use.
+
+## Citation
+Please cite this model using the following format:
+
+```
+@misc{Bielik7Bv01,
+    title     = {Introducing Bielik-7B-v0.1: Polish Language Model},
+    author    = {Ociepa, Krzysztof and Flis, Łukasz and Wróbel, Krzysztof and Gwoździej, Adrian and {SpeakLeash Team} and {Cyfronet Team}},
+    year      = {2024},
+    url       = {https://huggingface.co/speakleash/Bielik-7B-v0.1},
+    note      = {Accessed: 2024-04-01}, % change this date
+    urldate   = {2024-04-01} % change this date
+}
+```
+
+## Responsible for training the model
+
+* Krzysztof Ociepa - team leadership, conceptualizing, data preparation, process optimization, and oversight of training
+* Łukasz Flis - coordinating and supervising the training
+* Krzysztof Wróbel - benchmarks
+* Adrian Gwoździej - data cleaning and quality
+
+The model could not have been created without the commitment and work of the entire SpeakLeash team, whose contribution is also invaluable. Thanks to the hard work of many individuals, it was possible to gather a large amount of content in Polish and establish collaboration between the open-science SpeakLeash project and the HPC center: ACK Cyfronet AGH.
+
+## Contact Us
+
+If you have any questions or suggestions, please use the discussion tab. If you want to contact us directly, join our [Discord SpeakLeash](https://discord.gg/3G9DVM39).