starchat-alpha / README.md
lewtun's picture
lewtun HF staff
Update README.md
98bb64f
|
raw
history blame
2.9 kB
metadata
license: bigcode-openrail-m
datasets:
  - OpenAssistant/oasst1
  - databricks/databricks-dolly-15k
language:
  - en
library_name: transformers
tags:
  - code

Model Card for StarChat Alpha

StarChat is a series of language models that are fine-tuned from StarCoder to act as helpful coding assistants. StarChat Alpha is the first of these models, and as an alpha release is only intended for educational or research purpopses. In particular, the model has not been aligned to human preferences with techniques like RLHF, so may generate problematic content (especially when prompted to do so).

Model Details

Model Description

Model Sources [optional]

Uses

StarChat Alpha is intended for educational and/or research purposes and in that respect can be used to probe the programming capabilities of open-source language models.

Bias, Risks, and Limitations

Like most language models, StarChat Alpha will often hallucinate facts or generate problematic outputs (especially when prompted to do so).

How to Get Started with the Model

Use the code below to get started with the model.

from transformers import pipeline

pipe = pipeline("text-generation", model="HuggingFaceH4/starchat-alpha")
# Inputs use chat tokens 
inputs = "<|system|>\n<|end|>\n<|user|>How can I sort a list in Python?<|end|>\n<|assistant|>"
outputs = pipe(inputs)

Citation [optional]

BibTeX:

@article{Tunstall2023starchat-alpha,
  author = {Tunstall, Lewis and Lambert, Nathan and Rajani, Nazneen and Beeching, Edward and Le Scao, Teven and von Werra, Leandro and Han, Sheon and Schmid, Philipp and Rush, Alexander},
  title = {Creating a Coding Assistant with StarCoder},
  journal = {Hugging Face Blog},
  year = {2023},
  note = {https://huggingface.co/blog/starchat},
}