Create README.md

README.md

@@ -0,0 +1,56 @@
+---
+license: openrail
+---
+# Model description
+[AI Sweden](https://huggingface.co/AI-Sweden/) | [GPT-Sw3 126M](https://huggingface.co/AI-Sweden-Models/gpt-sw3-126m/) | [GPT-Sw3 356M](https://huggingface.co/AI-Sweden-Models/gpt-sw3-356m/) | [GPT-Sw3 1.3B](https://huggingface.co/AI-Sweden-Models/gpt-sw3-1.3b/) | [GPT-Sw3 6.7B](https://huggingface.co/AI-Sweden-Models/gpt-sw3-6.7b/) | [GPT-Sw3 20B](https://huggingface.co/AI-Sweden-Models/gpt-sw3-20b/)
+
+GPT-SW3 is a collection of large decoder-only pretrained transformer language models that were developed by AI Sweden in collaboration with RISE and the WASP WARA for Media and Language. GPT-SW3 has been trained on a dataset containing 320B tokens in Swedish, Norwegian, Danish, Icelandic, English, and programming code. The model was pretrained using a causal language modeling (CLM) objective utilizing the NeMo Megatron GPT implementation.
+
+# Intended use
+GPT-SW3 is an autoregressive large language model that is capable of generating coherent text in 5 different languages, and 4 programming languages. GPT-SW3 can also be instructed to perform text tasks that it has not been explicitly trained for, by casting them as text generation tasks. AI Sweden shares GPT-SW3 in a controlled pre-release with organizations and individuals in the Nordic NLP ecosystem who can contribute to the validation and testing of the models and provide feedback to the community. This is an important step in the process of validating the model and collecting feedback on both what works well and what does not.
+
+# Limitations
+Like other large language models for which the diversity (or lack thereof) of training data induces downstream impact on the quality of our model, GPT-SW3 has limitations in terms of for example bias and safety. GPT-SW3 can also have quality issues in terms of generation diversity and hallucination. By releasing with the RAIL license, we also hope to increase communication, transparency, and the study of large language models. The model may: overrepresent some viewpoints and underrepresent others, contain stereotypes, generate hateful, abusive, violent, discriminatory or prejudicial language. The model may make errors, including producing incorrect information as if it were factual, it may generate irrelevant or repetitive outputs, and content that may not be appropriate for all settings, including sexual content.
+
+# How to use
+The following code snippet loads our tokenizer & model, and uses the GPU if available.
+
+```python
+import torch
+from transformers import pipeline, AutoTokenizer, AutoModelForCausalLM
+
+# Initialize Variables
+model_name = "AI-Sweden/gpt-sw3-1.3b"
+device = "cuda:0" if torch.cuda.is_available() else "cpu"
+prompt = "Träd är fina för att"
+
+# Initialize Tokenizer & Model
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForCausalLM.from_pretrained(model_name)
+model.eval()
+model.to(device)
+```
+
+Generating text using the `generate` method is done as follows:
+```python
+input_ids = tokenizer(prompt, return_tensors="pt")["input_ids"].to(device)
+
+generated_token_ids = model.generate(
+    inputs=input_ids,
+    max_new_tokens=100,
+    do_sample=True,
+    temperature=0.6,
+    top_p=1,
+)[0]
+
+generated_text = tokenizer.decode(generated_token_ids)    
+```
+
+A convenient alternative to the `generate` method is the HuggingFace pipeline, which handles most of the work for you:
+```python
+generator = pipeline('text-generation', tokenizer=tokenizer, model=model, device=device)
+generated = generator(prompt, max_new_tokens=100, do_sample=True, temperature=0.6, top_p=1)[0]["generated_text"]
+```
+
+# Compliance
+The release of GPT-SW3 consists of model weights, a configuration file, a tokenizer file and a vocabulary file. None of these files contain any personally identifiable information (PII) or any copyrighted material.