README.md

---
extra_gated_prompt: >-
  ### NorLLM License
  
  Terms and Conditions for Use, Reproduction, and Distribution
  
  1. Definitions

  
  "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

  
  "Licensor" shall mean NTNU.

  
  "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

  
  "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

  
  "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

  
  "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

  
  "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

  
  "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

  
  "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

  
  "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
   
  2. Grant of Copyright License

  
  Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
   
  3. Grant of Patent License

  
  Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
   
  4. Redistribution

  
  You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

  
  4.1  Use Restrictions

  
  The Work or Derivative Works thereof may be used free of charge within the geographic extent defined in clause 4.2. The use is limited to the Your own purposes, but not for resale and not for purposes that may infringe on or negatively impact health, safety, environmental protection, and/or fundamental rights such as the right to human dignity, respect for private and family life, protection of personal data, freedom of expression and information, freedom of assembly and of association, and non-discrimination, consumer protection and the specific rights protecting children.

  
  4.2  Geographical Restriction

  
  Only organizations having residence or registered main office in the Nordic countries (Denmark, Norway, Sweden, Finland, and Iceland) are permitted to use the Work or Derivative Works thereof without additional consent, provided they comply with the other terms of this License.

  
  4.3  Attribution

  
  You must give any other recipients of the Work or Derivative Works a copy of this License; and

  
  You must cause any modified files to carry prominent notices stating that You changed the files; and

  
  You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

  
  If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

  
  You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

  
  5. Submission of Contributions

  
  Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
   
  6. Trademarks

  
  This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for describing the origin of the Work and reproducing the content of the NOTICE file.
   
  7. Disclaimer of Warranty

  
  Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
   
  8. Limitation of Liability

  
  In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
   
  9. Accepting Warranty or Additional Liability

  
  While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
   
  END OF TERMS AND CONDITIONS

  Contact people for technical questions:  Lemei Zhang ([email protected]), Peng Liu ([email protected])

  Contact people for license questions:  Jon Atle Gulla ([email protected])
  
extra_gated_fields:
  Name: text
  Organization: text
  Country: country
  Email address at work: text
  
  I want to use this model for:
    type: select
    options: 
      - Research
      - Education
      - Business
      - label: Other
        value: other
  I have read and accepted the conditions of the NorLLM license: checkbox
extra_gated_heading: "Acknowledge license to accept the repository"
extra_gated_description: "Our team may take 1-2 days to process your request"
extra_gated_button_content: "Acknowledge license"
---

<mark>Please note that access is limited to students, companies, and organizations from Nordic countries. Kindly provide your work email or student email to access the models. Thank you for your understanding.</mark>


---
## Model Details

NorwAI-Mistral-7B is continue-pretrained on [Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1) using 51B tokens. It belongs to NowAI LLM family developed by [NowAI research center at Norwegian University of Science and Technology (NTNU)](https://www.ntnu.edu/norwai) in collaboration with [Schibsted](https://schibsted.com/), [NRK](https://www.nrk.no/), [VG](https://www.vg.no/) and [the National Library of Norway](https://www.nb.no/en/). 

NorwAI LLM includes a collection of pretrained, continue pretrained and instruction tunned generative text models in 7B and 45B sizes with different archtectures. All pretrained and continue pretrained models are on the same dataset and with the same tokenizer. The instruction tuned models are optimized using high-quality Norwegian instructions collected from Norwegian native speakers. The development of these modesl is dedicated to promoting and developing the research and applications of Norwegian language models.

- **Developed by:** NowAI at NTNU, Schibsted and VG
<!-- **Funded by [optional]:** [More Information Needed]-->
<!-- **Shared by [optional]:** [More Information Needed]-->
- **Model type:** Generative text model
- **Language(s) (NLP):** Norwegian
- **Tokenizer:** We expanded the Norwegian vocabulary by merging the [Llama 2 tokenizer](https://huggingface.co/docs/transformers/en/model_doc/llama2) with the vocabulary from our own trained Norwegian tokenizer. The extended vocabulary size is 64000.
- **Models release date:** May 15, 2024 but are being continuously updated.

**NowAI LLM family** is based on auto-regressive language model architecture. 

|  model_name | #parameter | training scheme  |  context length | base model |
|-------|----|---|---|---|
| NorwAI-Mistral-7B | 7B  | continue-pretrain  | 32k  | [Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1) |
| NorwAI-Mistral-7B-pretrain | 7B | pretrain from scratch  |  32k | [Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1) |
| NorwAI-Llama2-7B | 7B |  continue-pretrain |  4096 | [Llama2](https://huggingface.co/docs/transformers/en/model_doc/llama2)  |
| NorwAI-Mixtral-8x7B | 45B |  continue-pretrain |  32k | [Mixtral-8x7B-v0.1](https://huggingface.co/mistralai/Mixtral-8x7B-v0.1) |
| NorwAI-Mistral-7B-instruct | 7B |  instruction tuning |  32k | [NorwAI-Mistral-7B](https://huggingface.co/NorwAI/NorwAI-Mistral-7B)  |
| NorwAI-Mixtral-8x7B-instruct | 45B |  instruction tuning |  32k | [NorwAI-Mixtral-8x7B](https://huggingface.co/NorwAI/NorwAI-Mixtral-8x7B) |


## Uses

NowAI LLM is intended for both commercial and research use in Nordic countries. To get access to the model, please carefully read the message and complete the required information.


## Bias, Risks, and Limitations

The model may have potential risks common to large language models, such as hallucination, factual inconsistency, toxicity, and bias etc.


## How to use

Let see the following example to load the model:

```python
from transformers import AutoTokenizer, AutoModelForCausalLM

model_and_tokenizer_path = "NorwAI/NorwAI-Mistral-7B"
access_token = "<your access token>"

# import tokenizer and the model
tokenizer = AutoTokenizer.from_pretrained(model_and_tokenizer_path, token=access_token)
model = AutoModelForCausalLM.from_pretrained(model_and_tokenizer_path, token=access_token, device_map='balanced')

# define your own prompt
prompt = """Hans Hyldbakk fra Surnadal var en"""

# generate response
inputs = tokenizer(prompt, return_tensors="pt")
outputs = model.generate(**inputs, 
                    min_new_tokens=50, 
                    max_new_tokens=100,
                    do_sample=True,
                    temperature=0.3)
outputs = tokenizer.decode(outputs[0], skip_special_tokens=True)

```


## Training Details

### Training Data

All NorwAI LLM models were (continue-)pretrained on 51.15 Billion tokens, equivalent to 30.33 Billion words, sourced from public datasets and data shared by Schibsted, NRK, and VG partners under agreement. The publicly available datasets were preprocessed to filter out texts with copyright issues, and all datasets were preprocessed to remove sensitive information. Among all the pretraining data, the ratio of Norwegian to other languages is 3 to 2. Among the languages other than Norwegian, Swedish and Danish account for the majority, with a small amount of English and other languages.

### Training Infrastructure

All models were pretrained and fine-tuned using the [llm-foundary framework](https://github.com/mosaicml/llm-foundry) on the [IDUN cluster](https://www.hpc.ntnu.no/idun/) in NTNU.

## Model Card Contact

Please contact the following people if you have any questions regarding the models:

Lemei Zhang, [[email protected]]([email protected])\
Peng Liu, [[email protected]]([email protected])