Instructions to use WisdomShell/CodeShell-7B-Chat with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use WisdomShell/CodeShell-7B-Chat with Transformers:

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

pipe = pipeline("text-generation", model="WisdomShell/CodeShell-7B-Chat", trust_remote_code=True)

# Load model directly
from transformers import AutoModelForCausalLM
model = AutoModelForCausalLM.from_pretrained("WisdomShell/CodeShell-7B-Chat", trust_remote_code=True, dtype="auto")

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use WisdomShell/CodeShell-7B-Chat with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/WisdomShell/CodeShell-7B-Chat

SGLang

How to use WisdomShell/CodeShell-7B-Chat 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 "WisdomShell/CodeShell-7B-Chat" \
    --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": "WisdomShell/CodeShell-7B-Chat",
		"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 "WisdomShell/CodeShell-7B-Chat" \
        --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": "WisdomShell/CodeShell-7B-Chat",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Docker Model Runner
How to use WisdomShell/CodeShell-7B-Chat with Docker Model Runner:
```
docker model run hf.co/WisdomShell/CodeShell-7B-Chat
```

ruixie commited on Nov 1, 2023

Commit

364c39f

1 Parent(s): 988e172

Update README.md

Browse files

Files changed (1) hide show

README.md +3 -5

README.md CHANGED Viewed

@@ -120,15 +120,13 @@ Despite our significant efforts to ensure compliance in the data used during the
 2. 关联方不得是面向个人用户的软件服务提供商或云服务提供商。
 3. 关联方不存在将获得授予的商业许可，在未经许可的前提下将其再授权给其他第三方的可能性。
-在满足上述条件的前提下，您需要通过向codeshell.opensource@gmail.com发送电子邮件提交申请。经审核通过后，将授予您一个全球的、非排他的、不可转让的、不可再授权的商业版权许可。
-Community use of the CodeShell model requires adherence to the CodeShell Model License Agreement and the Apache 2.0 License. The CodeShell model is allowed for commercial use, but if you plan to use the CodeShell model or its derivatives for commercial purposes, you need to ensure that the entity meets the following conditions:
 1. The Daily Active Users (DAU) of your or your affiliate's service or product is less than 1 million.
 2. You and your affiliates must not be a software service provider or cloud service provider targeting individual users.
 3. You and your affiliates should not have the possibility of sub-licensing to other third parties without obtaining the commercial license granted.
-Upon meeting the above conditions, you need to submit an application by sending an email to codeshell.opensource@gmail.com. After approval, you will be granted a global, non-exclusive, non-transferable, non-sublicensable commercial copyright license.

 2. 关联方不得是面向个人用户的软件服务提供商或云服务提供商。
 3. 关联方不存在将获得授予的商业许可，在未经许可的前提下将其再授权给其他第三方的可能性。
+在满足上述条件的前提下，您需要通过向codeshell.opensource@gmail.com发送电子邮件，提交《CodeShell模型许可协议》要求的申请材料。经审核通过后，将授予您一个全球的、非排他的、不可转让的、不可再授权的商业版权许可。
+Community use of the CodeShell model requires adherence to the ["CodeShell License Agreement"](https://huggingface.co/WisdomShell/CodeShell-7B/resolve/main/CodeShell%E6%A8%A1%E5%9E%8B%E8%AE%B8%E5%8F%AF%E5%8D%8F%E8%AE%AE.pdf) and the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). The CodeShell model is allowed for commercial use, but if you plan to use the CodeShell model or its derivatives for commercial purposes, you need to ensure that the entity meets the following conditions:
 1. The Daily Active Users (DAU) of your or your affiliate's service or product is less than 1 million.
 2. You and your affiliates must not be a software service provider or cloud service provider targeting individual users.
 3. You and your affiliates should not have the possibility of sub-licensing to other third parties without obtaining the commercial license granted.
+Under the aforementioned conditions, you need to submit the application materials required by the "CodeShell Model License Agreement" by sending an email to codeshell.opensource@gmail.com. After approval, you will be granted a global, non-exclusive, non-transferable, non-sublicensable commercial copyright license.