Update README.md
Browse files
README.md
CHANGED
|
@@ -45,103 +45,103 @@ This model was developed by StarfleetAI with the aim of it being used for autono
|
|
| 45 |
- **License:** Apache license 2.0
|
| 46 |
- **Finetuned from model:** `Open-Orca/Mistral-7B-OpenOrca`
|
| 47 |
|
| 48 |
-
## Uses
|
| 49 |
|
| 50 |
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 51 |
|
| 52 |
-
### Direct Use
|
| 53 |
|
| 54 |
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 55 |
|
| 56 |
-
[More Information Needed]
|
| 57 |
|
| 58 |
-
### Out-of-Scope Use
|
| 59 |
|
| 60 |
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 61 |
|
| 62 |
-
[More Information Needed]
|
| 63 |
|
| 64 |
-
## Bias, Risks, and Limitations
|
| 65 |
|
| 66 |
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 67 |
|
| 68 |
-
[More Information Needed]
|
| 69 |
|
| 70 |
-
### Recommendations
|
| 71 |
|
| 72 |
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 73 |
|
| 74 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 75 |
|
| 76 |
-
## How to Get Started with the Model
|
| 77 |
|
| 78 |
-
Use the code below to get started with the model.
|
| 79 |
|
| 80 |
-
[More Information Needed]
|
| 81 |
|
| 82 |
## Training Details
|
| 83 |
|
| 84 |
You can find the trainer code available [on Github](https://github.com/StarfleetAI/polaris/tree/main/small) under the Apache 2.0 license.
|
| 85 |
|
| 86 |
-
### Training Data
|
| 87 |
|
| 88 |
<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
|
| 89 |
|
| 90 |
-
[More Information Needed]
|
| 91 |
|
| 92 |
-
### Training Procedure
|
| 93 |
|
| 94 |
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 95 |
|
| 96 |
|
| 97 |
-
#### Training Hyperparameters
|
| 98 |
|
| 99 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 100 |
|
| 101 |
-
## Evaluation
|
| 102 |
|
| 103 |
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 104 |
|
| 105 |
-
### Testing Data, Factors & Metrics
|
| 106 |
|
| 107 |
-
#### Testing Data
|
| 108 |
|
| 109 |
<!-- This should link to a Dataset Card if possible. -->
|
| 110 |
|
| 111 |
-
[More Information Needed]
|
| 112 |
|
| 113 |
-
#### Factors
|
| 114 |
|
| 115 |
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 116 |
|
| 117 |
-
[More Information Needed]
|
| 118 |
|
| 119 |
-
#### Metrics
|
| 120 |
|
| 121 |
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 122 |
|
| 123 |
-
[More Information Needed]
|
| 124 |
|
| 125 |
-
### Results
|
| 126 |
|
| 127 |
-
[More Information Needed]
|
| 128 |
|
| 129 |
-
#### Summary
|
| 130 |
|
| 131 |
|
| 132 |
|
| 133 |
-
## Citation
|
| 134 |
|
| 135 |
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 136 |
|
| 137 |
-
**BibTeX:**
|
| 138 |
|
| 139 |
-
[More Information Needed]
|
| 140 |
|
| 141 |
-
**APA:**
|
| 142 |
|
| 143 |
-
[More Information Needed]
|
| 144 |
|
| 145 |
-
## Model Card Contact
|
| 146 |
|
| 147 |
-
[More Information Needed]
|
|
|
|
| 45 |
- **License:** Apache license 2.0
|
| 46 |
- **Finetuned from model:** `Open-Orca/Mistral-7B-OpenOrca`
|
| 47 |
|
| 48 |
+
<!-- ## Uses -->
|
| 49 |
|
| 50 |
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 51 |
|
| 52 |
+
<!-- ### Direct Use -->
|
| 53 |
|
| 54 |
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 55 |
|
| 56 |
+
<!-- [More Information Needed] -->
|
| 57 |
|
| 58 |
+
<!-- ### Out-of-Scope Use -->
|
| 59 |
|
| 60 |
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 61 |
|
| 62 |
+
<!-- [More Information Needed] -->
|
| 63 |
|
| 64 |
+
<!-- ## Bias, Risks, and Limitations -->
|
| 65 |
|
| 66 |
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 67 |
|
| 68 |
+
<!-- [More Information Needed] -->
|
| 69 |
|
| 70 |
+
<!-- ### Recommendations -->
|
| 71 |
|
| 72 |
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 73 |
|
| 74 |
+
<!-- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations. -->
|
| 75 |
|
| 76 |
+
<!-- ## How to Get Started with the Model -->
|
| 77 |
|
| 78 |
+
<!-- Use the code below to get started with the model. -->
|
| 79 |
|
| 80 |
+
<!-- [More Information Needed] -->
|
| 81 |
|
| 82 |
## Training Details
|
| 83 |
|
| 84 |
You can find the trainer code available [on Github](https://github.com/StarfleetAI/polaris/tree/main/small) under the Apache 2.0 license.
|
| 85 |
|
| 86 |
+
<!-- ### Training Data -->
|
| 87 |
|
| 88 |
<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
|
| 89 |
|
| 90 |
+
<!-- [More Information Needed] -->
|
| 91 |
|
| 92 |
+
<!-- ### Training Procedure -->
|
| 93 |
|
| 94 |
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 95 |
|
| 96 |
|
| 97 |
+
<!-- #### Training Hyperparameters -->
|
| 98 |
|
| 99 |
+
<!-- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 100 |
|
| 101 |
+
<!-- ## Evaluation -->
|
| 102 |
|
| 103 |
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 104 |
|
| 105 |
+
<!-- ### Testing Data, Factors & Metrics -->
|
| 106 |
|
| 107 |
+
<!-- #### Testing Data -->
|
| 108 |
|
| 109 |
<!-- This should link to a Dataset Card if possible. -->
|
| 110 |
|
| 111 |
+
<!-- [More Information Needed] -->
|
| 112 |
|
| 113 |
+
<!-- #### Factors -->
|
| 114 |
|
| 115 |
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 116 |
|
| 117 |
+
<!-- [More Information Needed] -->
|
| 118 |
|
| 119 |
+
<!-- #### Metrics -->
|
| 120 |
|
| 121 |
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 122 |
|
| 123 |
+
<!-- [More Information Needed] -->
|
| 124 |
|
| 125 |
+
<!-- ### Results -->
|
| 126 |
|
| 127 |
+
<!-- [More Information Needed] -->
|
| 128 |
|
| 129 |
+
<!-- #### Summary -->
|
| 130 |
|
| 131 |
|
| 132 |
|
| 133 |
+
<!-- ## Citation -->
|
| 134 |
|
| 135 |
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 136 |
|
| 137 |
+
<!-- **BibTeX:** -->
|
| 138 |
|
| 139 |
+
<!-- [More Information Needed] -->
|
| 140 |
|
| 141 |
+
<!-- **APA:** -->
|
| 142 |
|
| 143 |
+
<!-- [More Information Needed] -->
|
| 144 |
|
| 145 |
+
<!-- ## Model Card Contact -->
|
| 146 |
|
| 147 |
+
<!-- [More Information Needed] -->
|