Instructions to use apple/OpenELM-270M-Instruct with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use apple/OpenELM-270M-Instruct with Transformers:

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

pipe = pipeline("text-generation", model="apple/OpenELM-270M-Instruct", trust_remote_code=True)

# Load model directly
from transformers import AutoModelForCausalLM
model = AutoModelForCausalLM.from_pretrained("apple/OpenELM-270M-Instruct", trust_remote_code=True, dtype="auto")

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use apple/OpenELM-270M-Instruct with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/apple/OpenELM-270M-Instruct

SGLang

How to use apple/OpenELM-270M-Instruct 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 "apple/OpenELM-270M-Instruct" \
    --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": "apple/OpenELM-270M-Instruct",
		"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 "apple/OpenELM-270M-Instruct" \
        --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": "apple/OpenELM-270M-Instruct",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Docker Model Runner
How to use apple/OpenELM-270M-Instruct with Docker Model Runner:
```
docker model run hf.co/apple/OpenELM-270M-Instruct
```

Is Commercial-use Allowed for Compmanies?

by yacine-indeed-com - opened May 13, 2024

Discussion

yacine-indeed-com

May 13, 2024

The license mentions: "Apple grants you a personal, non-exclusive license".
Does this mean that the models cannot be used by companies/corporations to build products without infringing the license?

yacine-indeed-com changed discussion title from Is Commercial-use Allowed Foe Compmanies? to Is Commercial-use Allowed for Compmanies? May 13, 2024

appvoid

Jul 8, 2024

•

edited Jul 8, 2024

not an expert but... this is a relatively permissive license, allowing users to do quite a lot with the software, including modifying and redistributing it. However, it does require attribution to Apple when redistributing the unmodified software AND not promote it with Apple as a source of origin.

most-likely the purpose is to difference the current state of the weights (and code) to avoid getting sued, they are a company, we should respect they want to protect themselves for whatever use the models get.

i think that a fine-tuned, gguf version of this model should do the trick. i will use it for my app apple, please don't sue me! or at least let me know if im wrong.

Upload images, audio, and videos by dragging in the text input, pasting, or clicking here.

Tap or paste here to upload images

· Sign up or log in to comment