Update README.md

README.md

@@ -1,3 +1,143 @@
 ---
 license: cc-by-nc-4.0
+datasets:
+- chrisociepa/wikipedia-pl-20230401
+language:
+- pl
+library_name: transformers
+tags:
+- llama
+- ALLaMo
+pipeline_tag: text-generation
 ---
+
+# APT-1B-Base
+
+### Introduction
+
+At [Azurro](https://azurro.pl), we consistently place importance on using the Open Source technologies, both while working on the projects and in our everyday lives. We have decided to share a base language model trained by us. We are confident that smaller language models have great potential, and direct access to them for all people that are interested in such models democratizes this significant and dynamically changing field even more.
+
+### Statements
+
+Training large language models requires a lot of computing power and it is meant for the major players on the market. However, does it mean that individuals or small companies cannot train language models capable of performing specific tasks? We decided to answer this question and train our own language model from scratch. 
+We have made the following statements:
+
+* we use 1 consumer graphic card
+* we train the model only with the Polish corpus
+* we use manually selected, high quality texts for training the model.
+
+Why have we made such statements?
+It is worth noting that training a model requires several times more resources than using it. To put it simply, it can be assumed that it is about 3-4 times more. Therefore, if a model can be run with a graphic card that has 6 GB VRAM, then training this model requires about 24 GB VRAM (this is the minimum value).
+
+Many consumer computers are equipped with good quality graphic cards that can be used for training a model at one’s own home. This is why we have decided to use a top consumer graphic card - Nvidia’s RTX 4090 24GB VRAM.
+
+All the currently available language models have been trained mainly with English corpora with a little bit of other languages, including Polish. The effect is that these models are not the best at dealing with the Polish texts. Even the popular GPT-3.5 model from OpenAI often has issues with correct forms. Therefore we have decided to prepare a model based only on the Polish corpus. An additional advantage of using only the Polish corpus is the size of the model - it is better to focus on one language in the case of smaller models.
+
+It is important to remember that models are as good as the data with which they are trained. Having regard to the small size of the model, we trained it with carefully selected texts. This is why we have not used corpora such as Common Crawl that contain a lot of poor quality data. Our team has prepared a set of sources that then have been processed and used for training the model.
+
+### Model
+
+APT-1B-Base is a base model introducing a new series of the APT (Azurro Pretrained Transformer) models. It has been trained with the use of an original open source framework called [ALLaMo](https://github.com/chrisociepa/allamo). This framework allows the user to train language models similar to the Meta AI’s LLaMA models quickly and efficiently.
+
+APT-1B-Base is an autoregressive language model based on the architecture of a transformer. It has been trained with data collected before April 2023.
+
+20 billion tokens have been used for training, and the training dataset (the Polish corpus) has 3 billion tokens. Chinchilla’s scaling law has been applied (20 tokens per every model parameter).
+
+A special tokenizer has been prepared and trained for the purpose of training the model.
+
+Model description:
+
+* developed by [Azurro](https://azurro.pl)
+* language: Polish
+* model type: causal decoder-only
+* license: CC BY NC 4.0 (non-commercial use)
+
+Model details:
+
+* model parameters: 1060M
+* sequence length: 2048
+* vocabulary size: 8000
+* layers: 20
+* heads: 16
+* d_head: 128
+* d_model: 2048
+* dropout: 0.0
+* no bias
+* positional encoding: RoPE
+* activation function: SwiGLU
+* normalizing function: RMSNorm 
+* intermediate size: 5632
+* norm epsilon: 1e-06
+
+Training hyperparameters:
+
+* micro batch size: 1
+* gradient accumulation steps: 264
+* batch size: 540672 = 1 * 264 * 2048
+* learning rate: 3e-04
+* optimizer: AdamW, (β1, β2) = (0.9, 0.95), adam_eps = 1e−8
+* weight decay: 0.1
+* grad clip: 1.0
+
+Tokenizer details:
+
+* type: BPE
+* special tokens: 7
+* alphabet size: 112 
+* vocabulary size: 8000
+
+### Training dataset
+
+Collecting a large amount of high quality training data is a great challenge. Over the past years at Azurro, we have done a lot of projects connected with processing Big Data. Therefore, with our extensive experience, we have been able to prepare carefully selected training dataset quickly and efficiently.
+
+Our training dataset contains:
+
+* ebooks: 1354 million tokens
+* Polish Wikipedia: 970 million tokens
+* web crawl data: 813 million tokens
+
+# How to Use
+
+Our model is fully compatible with HuggingFace - you can use it right away.
+
+Regarding the full precision, it can be run on a graphic card with 6 GB VRAM.
+
+```python
+import transformers
+model = transformers.AutoModelForCausalLM.from_pretrained('Azurro/APT-1B-Base')
+```
+
+In order to reduce the memory usage, you can use smaller precision (bfloat16) and run the model on a graphic card with 4 GB VRAM.
+
+```python
+import transformers
+model = transformers.AutoModelForCausalLM.from_pretrained('Azurro/APT-1B-Base', torch_dtype=torch.bfloat16)
+```
+
+### Limitations and Biases
+
+APT-1B-Base is not intended for deployment without fine-tuning. It should not be used for human-facing interactions without further guardrails and user consent.
+
+APT-1B-Base can produce factually incorrect output, and should not be relied on to produce factually accurate information. APT-1B-Base was trained on various public datasets. While great efforts have been taken to clean the pretraining data, it is possible that this model could generate lewd, biased or otherwise offensive outputs.
+
+### License
+
+Because of an unclear legal situation, we have decided to publish the model under CC BY NC 4.0 license - it allows for non-commercial use. The model can be used for scientific purposes and privately, as long as the license conditions are met.
+
+### Disclaimer
+
+The license on this model does not constitute legal advice. We are not responsible for the actions of third parties who use this model.
+
+### Citation
+Please cite this model using the following format:
+
+```
+@online{AzurroAPT1BBase,
+    author    = {Krzysztof Ociepa, Azurro},
+    title     = {Introducing APT-1B-Base: a new open source LLM for Polish},
+    year      = {2023},
+    url       = {www.azurro.pl},
+    note      = {Accessed: 2023-06-14}, % change this date
+    urldate   = {2023-06-14} % change this date
+}
+```