Instructions to use goldfish-models/bew_cyrl_10mb with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use goldfish-models/bew_cyrl_10mb with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("text-generation", model="goldfish-models/bew_cyrl_10mb")

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("goldfish-models/bew_cyrl_10mb")
model = AutoModelForCausalLM.from_pretrained("goldfish-models/bew_cyrl_10mb")

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use goldfish-models/bew_cyrl_10mb with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "goldfish-models/bew_cyrl_10mb"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "goldfish-models/bew_cyrl_10mb",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker

docker model run hf.co/goldfish-models/bew_cyrl_10mb

SGLang

How to use goldfish-models/bew_cyrl_10mb with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "goldfish-models/bew_cyrl_10mb" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "goldfish-models/bew_cyrl_10mb",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "goldfish-models/bew_cyrl_10mb" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "goldfish-models/bew_cyrl_10mb",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Docker Model Runner
How to use goldfish-models/bew_cyrl_10mb with Docker Model Runner:
```
docker model run hf.co/goldfish-models/bew_cyrl_10mb
```

goldfish-models commited on Aug 20, 2024

Commit

aedb68b

verified ·

1 Parent(s): 5a49e1a

Upload README.md with huggingface_hub

Browse files

Files changed (1) hide show

README.md +2 -0

README.md CHANGED Viewed

@@ -18,6 +18,8 @@ Goldfish is a suite of monolingual language models trained for 350 languages.
 This model is the <b>Betawi</b> (Cyrillic script) model trained on 10MB of data, after accounting for an estimated byte premium of 1.74; content-matched text in Betawi takes on average 1.74x as many UTF-8 bytes to encode as English.
 The Goldfish models are trained primarily for comparability across languages and for low-resource languages; Goldfish performance for high-resource languages is not designed to be comparable with modern large language models (LLMs).
 Note: bew_cyrl is an [individual language](https://iso639-3.sil.org/code_tables/639/data) code. It is not contained in any macrolanguage codes contained in Goldfish (for script cyrl).
 All training and hyperparameter details are in our paper, [Goldfish: Monolingual Language Models for 350 Languages (Chang et al., 2024)](https://github.com/tylerachang/goldfish/blob/main/goldfish_paper_20240815.pdf).

 This model is the <b>Betawi</b> (Cyrillic script) model trained on 10MB of data, after accounting for an estimated byte premium of 1.74; content-matched text in Betawi takes on average 1.74x as many UTF-8 bytes to encode as English.
 The Goldfish models are trained primarily for comparability across languages and for low-resource languages; Goldfish performance for high-resource languages is not designed to be comparable with modern large language models (LLMs).
+Note: This language is available in Goldfish with other scripts (writing systems). See: bew_latn.
 Note: bew_cyrl is an [individual language](https://iso639-3.sil.org/code_tables/639/data) code. It is not contained in any macrolanguage codes contained in Goldfish (for script cyrl).
 All training and hyperparameter details are in our paper, [Goldfish: Monolingual Language Models for 350 Languages (Chang et al., 2024)](https://github.com/tylerachang/goldfish/blob/main/goldfish_paper_20240815.pdf).