<span style="color:red"><b>WARNING:</b> The checkpoints on this repo are not fully trained model. Evaluations of intermediary checkpoints and the final model will be added when conducted (see below).</span>

<p>BLOOM LM<br/> BigScience Large Open-science Open-access Multilingual Language Model <br/>Model Card</p>

<img src="https://assets.website-files.com/6139f3cdcbbff3a68486761d/613cd8997b270da063e230c5_Tekengebied%201-p-500.png" alt="BigScience Logo" width="200"/>

Version 1.3 / 11.July.2022 - Available intermediary checkpoints - global steps:

You can check the available checkpoints by clicking on the branches section of the repo

How to load a specific version

We use git tags to load a model in a specific version (eg. global_step1000):

from transformers import AutoModelForCausalLM
model = AutoModelForCausalLM.from_pretrained(
	"bigscience/bloom-1b3-intermediate",
	revision="global_step1000",
	torch_dtype="auto",
)

Table of Contents

  1. Model Details
  2. Uses
  3. Training Data
  4. Risks and Limitations
  5. Evaluation
  6. Recommendations
  7. Glossary and Calculations
  8. More Information
  9. Model Card Authors

Model Details

BLOOM is a type of language model, which is a probability distribution over sequences of words. Specifically, BLOOM is a Large Language Model (LLM), meaning that it is trained on vast amounts of text data using industrial-scale computational resources. As such, the model is able to capture the statistical tendencies of words, phrases, sentences, and larger spans of text that it is exposed to in the training data.

Basics

This section provides information about the model type, version, license, funders, release date, developers, and contact information. It is useful for anyone who wants to reference the model.

<details> <summary>Click to expand</summary>

Developed by: BigScience (website)

All collaborators are either volunteers or have an agreement with their employer. (Further breakdown of participants forthcoming.)

Model Type: Transformer-based Language Model

Version: 1.0.0

Languages: Multiple; see training data

License: RAIL License v1.0 (link)

Release Date Estimate: Monday, 11.July.2022

Send Questions to: bigscience-contact@googlegroups.com

Cite as: BigScience, BigScience Language Open-science Open-access Multilingual (BLOOM) Language Model. International, May 2021-May 2022

Funded by:

</details>

Technical Specifications

This section includes details about the model objective and architecture, and the compute infrastructure. It is useful for people interested in model development.

<details> <summary>Click to expand</summary>

Please see the BLOOM training README for full details on replicating training.

Model Architecture and Objective

Objective Function: Cross Entropy with mean reduction (see API documentation).

Compute infrastructure

Jean Zay Public Supercomputer, provided by the French government (see announcement).

Hardware

Software

</details>


Training

This section provides information about the training data, the speed and size of training elements, and the environmental impact of training. It is useful for people who want to learn more about the model inputs and training footprint.

<details> <summary>Click to expand</summary>

Training Data

This section provides a high-level overview of the training data. It is relevant for anyone who wants to know the basics of what the model is learning.

Details for each dataset are provided in individual Data Cards.

Training data includes:

Languages

The pie chart shows the distribution of languages in training data.

pie chart showing the distribution of languages in training data

The following tables shows the further distribution of Niger-Congo & Indic languages and programming languages in the training data.

Distribution of Niger Congo and Indic languages.

Niger Congo Percentage Indic Percentage
Chi Tumbuka 0.00002 Assamese 0.01
Kikuyu 0.00004 Odia 0.04
Bambara 0.00004 Gujarati 0.04
Akan 0.00007 Marathi 0.05
Xitsonga 0.00007 Punjabi 0.05
Sesotho 0.00007 Kannada 0.06
Chi Chewa 0.0001 Nepali 0.07
Setswana 0.0002 Telugu 0.09
Northern Sotho 0.0002 Malayalam 0.10
Fon 0.0002 Urdu 0.10
Kirundi 0.0003 Tamil 0.20
Wolof 0.0004 Bengali 0.50
Kuganda 0.0004 Hindi 0.70
Chi Shona 0.001
Isi Zulu 0.001
Igbo 0.001
Xhosa 0.001
Kinyarwanda 0.003
Yoruba 0.006
Swahili 0.02

Distribution of programming languages.

Extension Language Number of files
java Java 5,407,724
php PHP 4,942,186
cpp C++ 2,503,930
py Python 2,435,072
js JavaScript 1,905,518
cs C# 1,577,347
rb Ruby 6,78,413
cc C++ 443,054
hpp C++ 391,048
lua Lua 352,317
go GO 227,763
ts TypeScript 195,254
C C 134,537
scala Scala 92,052
hh C++ 67,161
H C++ 55,899
tsx TypeScript 33,107
rs Rust 29,693
phpt PHP 9,702
c++ C++ 1,342
h++ C++ 791
php3 PHP 540
phps PHP 270
php5 PHP 166
php4 PHP 29

Preprocessing

Tokenization: The BLOOM tokenizer (link), a learned subword tokenizer trained using:

It was trained on a subset of a preliminary version of the corpus using alpha-weighting per language.

Speeds, Sizes, Times

Training logs: Tensorboard link

Environmental Impact

The training supercomputer, Jean Zay (website), uses mostly nuclear energy. The heat generated by it is reused for heating campus housing.

Estimated carbon emissions: (Forthcoming.)

Estimated electricity usage: (Forthcoming.)

</details>


Uses

This section addresses questions around how the model is intended to be used, discusses the foreseeable users of the model (including those affected by the model), and describes uses that are considered out of scope or misuse of the model. It is useful for anyone considering using the model or who is affected by the model.

<details> <summary>Click to expand</summary>

Intended Use

This model is being created in order to enable public research on large language models (LLMs). LLMs are intended to be used for language generation or as a pretrained base model that can be further fine-tuned for specific tasks. Use cases below are not exhaustive.

Direct Use

Downstream Use

Misuse and Out-of-scope Use

This section addresses what users ought not do with the model.

See the BLOOM License, Attachment A, for detailed usage restrictions. The below list is non-exhaustive, but lists some easily foreseeable problematic use cases.

Out-of-scope Uses

Using the model in high-stakes settings is out of scope for this model. The model is not designed for critical decisions nor uses with any material consequences on an individual's livelihood or wellbeing. The model outputs content that appears factual but is not correct.

Out-of-scope Uses Include:

Misuse

Intentionally using the model for harm, violating human rights, or other kinds of malicious activities, is a misuse of this model. This includes:

Intended Users

Direct Users

Indirect Users

Others Affected (Parties Prenantes)

</details>


Risks and Limitations

This section identifies foreseeable harms and misunderstandings.

<details> <summary>Click to expand</summary>

Model may:

</details>


Evaluation

This section describes the evaluation protocols and provides the results.

<details> <summary>Click to expand</summary>

Metrics

This section describes the different ways performance is calculated and why.

Includes:

Metric Why chosen
Perplexity Standard metric for quantifying model improvements during training
Cross Entropy Loss Standard objective for language models.

And multiple different metrics for specific tasks. (More evaluation metrics forthcoming upon completion of evaluation protocol.)

Factors

This section lists some different aspects of what BLOOM models. Its focus is on those aspects that are likely to give rise to high variance in model behavior.

Results

Results are based on the Factors and Metrics.

Train-time Evaluation:

As of 25.May.2022, 15:00 PST:

(More evaluation scores forthcoming.)

</details>


Recommendations

This section provides information on warnings and potential mitigations.

<details> <summary>Click to expand</summary>

</details>


Glossary and Calculations

This section defines common terms and how metrics are calculated. <details> <summary>Click to expand</summary>

</details>


More Information

This section provides links to writing on dataset creation, technical specifications, lessons learned, and initial results.

<details> <summary>Click to expand</summary>

Dataset Creation

Blog post detailing the design choices during the dataset creation: https://bigscience.huggingface.co/blog/building-a-tb-scale-multilingual-dataset-for-language-modeling

Technical Specifications

Blog post summarizing how the architecture, size, shape, and pre-training duration where selected: https://bigscience.huggingface.co/blog/what-language-model-to-train-if-you-have-two-million-gpu-hours

More details on the architecture/optimizer: https://github.com/bigscience-workshop/bigscience/tree/master/train/tr11-176B-ml

Blog post on the hardware/engineering side: https://bigscience.huggingface.co/blog/which-hardware-to-train-a-176b-parameters-model

Details on the distributed setup used for the training: https://github.com/bigscience-workshop/bigscience/tree/master/train/tr11-176B-ml

Tensorboard updated during the training: https://huggingface.co/bigscience/tr11-176B-ml-logs/tensorboard#scalars&tagFilter=loss

Lessons

Insights on how to approach training, negative results: https://github.com/bigscience-workshop/bigscience/blob/master/train/lessons-learned.md

Details on the obstacles overcome during the preparation on the engineering side (instabilities, optimization of training throughput, so many technical tricks and questions): https://github.com/bigscience-workshop/bigscience/blob/master/train/tr11-176B-ml/chronicles.md

Initial Results

Initial prompting experiments using interim checkpoints: https://huggingface.co/spaces/bigscience/bloom-book

</details>


Model Card Authors

Ordered roughly chronologically and by amount of time spent.

Margaret Mitchell, Giada Pistilli, Yacine Jernite, Ezinwanne Ozoani, Marissa Gerchick, Nazneen Rajani, Sasha Luccioni, Irene Solaiman, Maraim Masoud, Somaieh Nikpoor, Carlos Muñoz Ferrandis, Stas Bekman, Christopher Akiki, Danish Contractor, David Lansky, Angelina McMillan-Major, Tristan Thrush, Suzana Ilić, Gérard Dupont, Shayne Longpre, Manan Dey, Stella Biderman, Douwe Kiela, Emi Baylor, Teven Le Scao, Aaron Gokaslan, Julien Launay, Niklas Muennighoff