Instructions to use codeparrot/starcoder-self-instruct with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use codeparrot/starcoder-self-instruct with Transformers:

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

pipe = pipeline("text-generation", model="codeparrot/starcoder-self-instruct")

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("codeparrot/starcoder-self-instruct")
model = AutoModelForCausalLM.from_pretrained("codeparrot/starcoder-self-instruct")

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use codeparrot/starcoder-self-instruct with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/codeparrot/starcoder-self-instruct

SGLang

How to use codeparrot/starcoder-self-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 "codeparrot/starcoder-self-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": "codeparrot/starcoder-self-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 "codeparrot/starcoder-self-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": "codeparrot/starcoder-self-instruct",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Docker Model Runner
How to use codeparrot/starcoder-self-instruct with Docker Model Runner:
```
docker model run hf.co/codeparrot/starcoder-self-instruct
```

ArmelR commited on Jun 9, 2023

Commit

06f4a41

1 Parent(s): 7a4a4fe

Update README.md

Browse files

Files changed (1) hide show

README.md +2 -5

README.md CHANGED Viewed

@@ -12,10 +12,6 @@ This model is an instruction-tuned version of ⭐️ StarCoder. The instruction
 which was built by boostrapping on StarCoder's generations.
 ## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 The model was fine-tuned with the following template
 ```
@@ -23,7 +19,8 @@ Question: <instruction>
 Answer: <output>
 ```
-For example, your prompt can look like
 ```python
 instruction = "Write a function to compute the GCD between two integers a and b"
 prompt = f"Question:{instruction}\n\nAnswer:"

 which was built by boostrapping on StarCoder's generations.
 ## Uses
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 The model was fine-tuned with the following template
 ```
 Answer: <output>
 ```
+For example, if you have your model and tokenizer loaded, you can use the following code to make the model generate the right output to a given instruction
 ```python
 instruction = "Write a function to compute the GCD between two integers a and b"
 prompt = f"Question:{instruction}\n\nAnswer:"