Skip to content

Commit 31b0489

Browse files
committed
docs: Update publish strategy to include Ollama publishing
Signed-off-by: Alina Ryan <aliryan@redhat.com>
1 parent 70289bf commit 31b0489

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

Diff for: docs/huggingface-publish-strategy.md renamed to docs/publish-strategy.md

+23-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1-
# HuggingFace Publish Strategy for InstructLab
1+
# Publishing Strategy for InstructLab
22

3-
This document describes the publishing strategy used for all models in the [InstructLab](https://huggingface.co/instructlab) organization.
3+
This document describes the publishing strategy used for all models in the InstructLab HuggingFace [organization](https://huggingface.co/instructlab) and the InstructLab Ollama [user account](https://ollama.com/instructlab).
44

55
## What are we publishing and why?
66

7-
The InstructLab team will be periodically training the full unquantized model with new Pull Requests to the [taxonomy](https://github.com/instructlab/taxonomy) repository. When the evaluation shows that the model has improved, the team will be publishing an unquantized model and a 4-bit quantized GGUF form model to a platform called HuggingFace.
7+
The InstructLab team will be periodically training the full unquantized model with new Pull Requests to the [taxonomy](https://github.com/instructlab/taxonomy) repository. When the evaluation shows that the model has improved, the team will be publishing 4-bit quantized GGUF form model to a platform called Ollama and both an unquantized model and a 4-bit quantized GGUF form model to a platform called HuggingFace.
8+
9+
## What is Ollama?
10+
11+
[Ollama](https://ollama.com/) is a platform that allows users to run open-source large language models locally on their machines. Ollama covers a broad spectrum of users, from seasoned AI professionals to people looking to explore the potential of AI and makes it easier for users to leverage the power of LLMs without having to rely on a cloud infrastructure. Since Ollama only supports publishing GGUF models, we will only be publishing the 4-bit quantized versions of our merlinite and granite models to the InstructLab Ollama user account.
812

913
## What is HuggingFace?
1014

@@ -16,15 +20,15 @@ We will be publishing two different kinds of model families - Merlinite and Gran
1620

1721
The Merlinite model family is based off the [Mistral](https://mistral.ai/) model family and uses the [Large-scale Alignment for chatBots (LAB)](https://arxiv.org/abs/2403.01081) alignment. You can read more about it [here](https://huggingface.co/instructlab/merlinite-7b-lab).
1822

19-
The InstructLab organization will be publishing a community version of the Merlinite 7B size model, in both unquantized and 4-bit quantized GGUF form.
23+
The InstructLab organization will be publishing a community version of the Merlinite 7B size model, in both unquantized and 4-bit quantized GGUF form to HuggingFace and just the 4-bit quantized GGUF form to Ollama.
2024

2125
## Granite
2226

2327
The Granite model family is the [foundational model family](https://www.ibm.com/downloads/cas/X9W4O6BM) for the IBM watsonx AI platform, designed for usage in a business environment. You can read more about it [here](https://huggingface.co/instructlab/granite-7b-lab).
2428

25-
The InstructLab organization will be publishing a community version of the Granite 7B size model using the [Large-scale Alignment for chatBots (LAB)](https://arxiv.org/abs/2403.01081) alignment, in both unquantized and 4-bit quantized GGUF form.
29+
The InstructLab organization will be publishing a community version of the Granite 7B size model using the [Large-scale Alignment for chatBots (LAB)](https://arxiv.org/abs/2403.01081) alignment, in both unquantized and 4-bit quantized GGUF form to HuggingFace and just the 4-bit quantized GGUF form to Ollama.
2630

27-
## Naming Scheme
31+
## HuggingFace Naming Scheme
2832

2933
The naming scheme for both Merlinite and Granite will follow this generic scheme:
3034

@@ -39,6 +43,19 @@ The specific schemes that will be published are detailed below:
3943
| [`granite-7b-lab`](https://huggingface.co/instructlab/granite-7b-lab) | `release-yyyymmdd` | Where the full precision Granite safetensors live |
4044
| [`granite-7b-lab-GGUF`](https://huggingface.co/instructlab/granite-7b-lab-GGUF) | `release-yyyymmdd` | Where the full precision and quantized Granite GGUFs live |
4145

46+
## Ollama Naming Scheme
47+
48+
The naming scheme for both Merlinite and Granite will follow this generic scheme:
49+
50+
`<model family> - <size> - <type (optional)> - <alignment>`
51+
52+
The specific schemes that will be published are detailed below:
53+
54+
| Model Family, Size, Alignment, etc. | Release Tag Format | Purpose |
55+
| --- | --- | --- |
56+
| [`merlinite-7b-lab`](https://ollama.com/instructlab/merlinite-7b-lab) | `release-yyyymmdd` | Where the full precision and quantized Merlinite GGUFs live |
57+
| [`granite-7b-lab`](https://ollama.com/instructlab/granite-7b-lab) | `release-yyyymmdd` | Where the full precision and quantized Granite GGUFs live |
58+
4259
## Retention Policy
4360

4461
The InstructLab team will maintain the most recent **10** published versions of the respective models.

0 commit comments

Comments
 (0)