Update README.md
Browse files
README.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
| 1 |
---
|
| 2 |
license: bigcode-openrail-m
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
| 4 |
|
| 5 |
# Model Card for StarChat Alpha
|
|
@@ -42,90 +50,16 @@ Like most language models, StarChat Alpha will often hallucinate facts or genera
|
|
| 42 |
|
| 43 |
Use the code below to get started with the model.
|
| 44 |
|
| 45 |
-
|
|
|
|
| 46 |
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
[More Information Needed]
|
| 54 |
-
|
| 55 |
-
### Training Procedure
|
| 56 |
-
|
| 57 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 58 |
-
|
| 59 |
-
#### Preprocessing [optional]
|
| 60 |
-
|
| 61 |
-
[More Information Needed]
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
#### Training Hyperparameters
|
| 65 |
-
|
| 66 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 67 |
-
|
| 68 |
-
#### Speeds, Sizes, Times [optional]
|
| 69 |
-
|
| 70 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 71 |
-
|
| 72 |
-
[More Information Needed]
|
| 73 |
-
|
| 74 |
-
## Evaluation
|
| 75 |
-
|
| 76 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 77 |
-
|
| 78 |
-
### Testing Data, Factors & Metrics
|
| 79 |
-
|
| 80 |
-
#### Testing Data
|
| 81 |
-
|
| 82 |
-
<!-- This should link to a Data Card if possible. -->
|
| 83 |
-
|
| 84 |
-
[More Information Needed]
|
| 85 |
-
|
| 86 |
-
#### Factors
|
| 87 |
-
|
| 88 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 89 |
-
|
| 90 |
-
[More Information Needed]
|
| 91 |
-
|
| 92 |
-
#### Metrics
|
| 93 |
-
|
| 94 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 95 |
-
|
| 96 |
-
[More Information Needed]
|
| 97 |
-
|
| 98 |
-
### Results
|
| 99 |
-
|
| 100 |
-
[More Information Needed]
|
| 101 |
-
|
| 102 |
-
#### Summary
|
| 103 |
-
|
| 104 |
-
|
| 105 |
-
|
| 106 |
-
## Model Examination [optional]
|
| 107 |
-
|
| 108 |
-
<!-- Relevant interpretability work for the model goes here -->
|
| 109 |
-
|
| 110 |
-
[More Information Needed]
|
| 111 |
-
|
| 112 |
-
## Technical Specifications [optional]
|
| 113 |
-
|
| 114 |
-
### Model Architecture and Objective
|
| 115 |
-
|
| 116 |
-
[More Information Needed]
|
| 117 |
-
|
| 118 |
-
### Compute Infrastructure
|
| 119 |
-
|
| 120 |
-
[More Information Needed]
|
| 121 |
-
|
| 122 |
-
#### Hardware
|
| 123 |
-
|
| 124 |
-
[More Information Needed]
|
| 125 |
|
| 126 |
-
#### Software
|
| 127 |
|
| 128 |
-
[More Information Needed]
|
| 129 |
|
| 130 |
## Citation [optional]
|
| 131 |
|
|
@@ -141,19 +75,4 @@ Use the code below to get started with the model.
|
|
| 141 |
year = {2023},
|
| 142 |
note = {https://huggingface.co/blog/starchat},
|
| 143 |
}
|
| 144 |
-
```
|
| 145 |
-
|
| 146 |
-
|
| 147 |
-
## More Information [optional]
|
| 148 |
-
|
| 149 |
-
[More Information Needed]
|
| 150 |
-
|
| 151 |
-
## Model Card Authors [optional]
|
| 152 |
-
|
| 153 |
-
[More Information Needed]
|
| 154 |
-
|
| 155 |
-
## Model Card Contact
|
| 156 |
-
|
| 157 |
-
[More Information Needed]
|
| 158 |
-
|
| 159 |
-
|
|
|
|
| 1 |
---
|
| 2 |
license: bigcode-openrail-m
|
| 3 |
+
datasets:
|
| 4 |
+
- OpenAssistant/oasst1
|
| 5 |
+
- databricks/databricks-dolly-15k
|
| 6 |
+
language:
|
| 7 |
+
- en
|
| 8 |
+
library_name: transformers
|
| 9 |
+
tags:
|
| 10 |
+
- code
|
| 11 |
---
|
| 12 |
|
| 13 |
# Model Card for StarChat Alpha
|
|
|
|
| 50 |
|
| 51 |
Use the code below to get started with the model.
|
| 52 |
|
| 53 |
+
```python
|
| 54 |
+
from transformers import pipeline
|
| 55 |
|
| 56 |
+
pipe = pipeline("text-generation", model="HuggingFaceH4/starchat-alpha")
|
| 57 |
+
# Inputs use chat tokens
|
| 58 |
+
inputs = "<|system|>\n<|end|>\n<|user|>How can I sort a list in Python?<|end|>\n<|assistant|>"
|
| 59 |
+
outputs = pipe(inputs)
|
| 60 |
+
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
|
|
|
|
| 62 |
|
|
|
|
| 63 |
|
| 64 |
## Citation [optional]
|
| 65 |
|
|
|
|
| 75 |
year = {2023},
|
| 76 |
note = {https://huggingface.co/blog/starchat},
|
| 77 |
}
|
| 78 |
+
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|