Update README.md
Browse files
README.md
CHANGED
@@ -52,64 +52,11 @@ Caution should be used when applying these models to downstream prediction tasks
|
|
52 |
|
53 |
## How to Get Started with the Model
|
54 |
|
55 |
-
See the [Get Started instructions]() with the associated codebase.
|
56 |
|
57 |
-
## Training Details
|
58 |
|
59 |
-
|
60 |
-
|
61 |
-
<!-- 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. -->
|
62 |
-
|
63 |
-
[More Information Needed]
|
64 |
-
|
65 |
-
### Training Procedure
|
66 |
-
|
67 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
68 |
-
|
69 |
-
#### Preprocessing
|
70 |
-
|
71 |
-
[More Information Needed]
|
72 |
-
|
73 |
-
|
74 |
-
#### Training Hyperparameters
|
75 |
-
|
76 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
77 |
-
|
78 |
-
#### Speeds, Sizes, Times [optional]
|
79 |
-
|
80 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
81 |
-
|
82 |
-
[More Information Needed]
|
83 |
-
|
84 |
-
## Evaluation
|
85 |
-
|
86 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
87 |
-
|
88 |
-
### Testing Data, Factors & Metrics
|
89 |
-
|
90 |
-
#### Testing Data
|
91 |
-
|
92 |
-
<!-- This should link to a Dataset Card if possible. -->
|
93 |
-
|
94 |
-
[More Information Needed]
|
95 |
-
|
96 |
-
#### Factors
|
97 |
-
|
98 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
99 |
-
|
100 |
-
[More Information Needed]
|
101 |
-
|
102 |
-
#### Metrics
|
103 |
-
|
104 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
105 |
-
|
106 |
-
[More Information Needed]
|
107 |
-
|
108 |
-
### Results
|
109 |
-
|
110 |
-
[More Information Needed]
|
111 |
-
|
112 |
-
#### Summary
|
113 |
|
114 |
|
115 |
## Environmental Impact
|
@@ -124,52 +71,21 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
124 |
- **Compute Region:** N/A
|
125 |
- **Carbon Emitted:** 50 kg CO2 eq.
|
126 |
|
127 |
-
##
|
128 |
-
|
129 |
-
### Model Architecture and Objective
|
130 |
-
|
131 |
-
[More Information Needed]
|
132 |
-
|
133 |
-
### Compute Infrastructure
|
134 |
-
|
135 |
-
[More Information Needed]
|
136 |
-
|
137 |
-
#### Hardware
|
138 |
-
|
139 |
-
[More Information Needed]
|
140 |
-
|
141 |
-
#### Software
|
142 |
-
|
143 |
-
[More Information Needed]
|
144 |
-
|
145 |
-
## Citation [optional]
|
146 |
|
147 |
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
|
|
148 |
|
149 |
**BibTeX:**
|
150 |
|
151 |
-
[More Information Needed]
|
152 |
|
153 |
**APA:**
|
154 |
|
155 |
-
[More Information Needed]
|
156 |
-
|
157 |
-
## Glossary [optional]
|
158 |
-
|
159 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
160 |
-
|
161 |
-
[More Information Needed]
|
162 |
-
|
163 |
-
## More Information [optional]
|
164 |
-
|
165 |
-
[More Information Needed]
|
166 |
|
167 |
-
## Model Card Authors [optional]
|
168 |
|
169 |
-
[More Information Needed]
|
170 |
|
171 |
## Model Card Contact
|
172 |
|
173 |
-
|
174 |
|
175 |
|
|
|
52 |
|
53 |
## How to Get Started with the Model
|
54 |
|
55 |
+
See the [Get Started instructions](https://github.com/DavidBellamy/labrador?tab=readme-ov-file#get-started) with the associated codebase.
|
56 |
|
57 |
+
## Training & Evaluation Details
|
58 |
|
59 |
+
See the associated [publication]() and [codebase](https://github.com/DavidBellamy/labrador).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
60 |
|
61 |
|
62 |
## Environmental Impact
|
|
|
71 |
- **Compute Region:** N/A
|
72 |
- **Carbon Emitted:** 50 kg CO2 eq.
|
73 |
|
74 |
+
## Citation
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
75 |
|
76 |
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
77 |
+
If you use Labrador in your work, please cite:
|
78 |
|
79 |
**BibTeX:**
|
80 |
|
|
|
81 |
|
82 |
**APA:**
|
83 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
84 |
|
|
|
85 |
|
|
|
86 |
|
87 |
## Model Card Contact
|
88 |
|
89 |
+
Correspondence to David Bellamy. You can find my contact on my personal website: https://davidbellamy.github.io/
|
90 |
|
91 |
|