ShirinYamani
commited on
Commit
•
8fbcf8c
1
Parent(s):
f5462d3
Update README.md
Browse files
README.md
CHANGED
@@ -7,156 +7,31 @@ tags: []
|
|
7 |
|
8 |
### Model Description
|
9 |
|
10 |
-
<!-- Provide a longer summary of what this model is. -->
|
11 |
|
12 |
-
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
13 |
|
14 |
-
-
|
15 |
-
- **Funded by [optional]:** [More Information Needed]
|
16 |
-
- **Shared by [optional]:** [More Information Needed]
|
17 |
-
- **Model type:** [More Information Needed]
|
18 |
-
- **Language(s) (NLP):** [More Information Needed]
|
19 |
-
- **License:** [More Information Needed]
|
20 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
21 |
|
22 |
-
### Model Sources
|
23 |
|
24 |
-
|
|
|
25 |
|
26 |
-
- **Repository:** [More Information Needed]
|
27 |
-
- **Paper [optional]:** [More Information Needed]
|
28 |
-
- **Demo [optional]:** [More Information Needed]
|
29 |
-
|
30 |
-
## Uses
|
31 |
-
|
32 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
33 |
-
|
34 |
-
### Direct Use
|
35 |
-
|
36 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
37 |
-
|
38 |
-
[More Information Needed]
|
39 |
-
|
40 |
-
### Downstream Use [optional]
|
41 |
-
|
42 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
43 |
-
|
44 |
-
[More Information Needed]
|
45 |
-
|
46 |
-
### Out-of-Scope Use
|
47 |
-
|
48 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
49 |
-
|
50 |
-
[More Information Needed]
|
51 |
-
|
52 |
-
## Bias, Risks, and Limitations
|
53 |
-
|
54 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
55 |
-
|
56 |
-
[More Information Needed]
|
57 |
-
|
58 |
-
### Recommendations
|
59 |
-
|
60 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
61 |
-
|
62 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
63 |
|
64 |
## How to Get Started with the Model
|
65 |
|
66 |
-
|
67 |
-
|
68 |
-
[More Information Needed]
|
69 |
|
70 |
-
## Training Details
|
71 |
|
72 |
-
|
73 |
|
74 |
-
|
75 |
|
76 |
-
[More Information Needed]
|
77 |
-
|
78 |
-
### Training Procedure
|
79 |
-
|
80 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
81 |
|
82 |
#### Preprocessing [optional]
|
83 |
|
84 |
-
|
85 |
-
|
86 |
-
|
87 |
-
#### Training Hyperparameters
|
88 |
-
|
89 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
90 |
-
|
91 |
-
#### Speeds, Sizes, Times [optional]
|
92 |
-
|
93 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
94 |
-
|
95 |
-
[More Information Needed]
|
96 |
-
|
97 |
-
## Evaluation
|
98 |
-
|
99 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
100 |
-
|
101 |
-
### Testing Data, Factors & Metrics
|
102 |
-
|
103 |
-
#### Testing Data
|
104 |
-
|
105 |
-
<!-- This should link to a Dataset Card if possible. -->
|
106 |
-
|
107 |
-
[More Information Needed]
|
108 |
-
|
109 |
-
#### Factors
|
110 |
-
|
111 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
112 |
-
|
113 |
-
[More Information Needed]
|
114 |
-
|
115 |
-
#### Metrics
|
116 |
-
|
117 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
118 |
-
|
119 |
-
[More Information Needed]
|
120 |
-
|
121 |
-
### Results
|
122 |
-
|
123 |
-
[More Information Needed]
|
124 |
-
|
125 |
-
#### Summary
|
126 |
-
|
127 |
-
|
128 |
-
|
129 |
-
## Model Examination [optional]
|
130 |
-
|
131 |
-
<!-- Relevant interpretability work for the model goes here -->
|
132 |
-
|
133 |
-
[More Information Needed]
|
134 |
-
|
135 |
-
## Environmental Impact
|
136 |
-
|
137 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
138 |
-
|
139 |
-
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
140 |
-
|
141 |
-
- **Hardware Type:** [More Information Needed]
|
142 |
-
- **Hours used:** [More Information Needed]
|
143 |
-
- **Cloud Provider:** [More Information Needed]
|
144 |
-
- **Compute Region:** [More Information Needed]
|
145 |
-
- **Carbon Emitted:** [More Information Needed]
|
146 |
-
|
147 |
-
## Technical Specifications [optional]
|
148 |
-
|
149 |
-
### Model Architecture and Objective
|
150 |
-
|
151 |
-
[More Information Needed]
|
152 |
-
|
153 |
-
### Compute Infrastructure
|
154 |
-
|
155 |
-
[More Information Needed]
|
156 |
-
|
157 |
-
#### Hardware
|
158 |
|
159 |
-
|
160 |
|
161 |
-
|
162 |
|
|
|
7 |
|
8 |
### Model Description
|
9 |
|
|
|
10 |
|
|
|
11 |
|
12 |
+
This model is a fine-tuned model of the tiny size of Chronos family models, fine-tuned on public electricity load data of Alberta, Canada for the period of 2017-2020, the dataset is also uploaded on the Dataset section of my profile
|
|
|
|
|
|
|
|
|
|
|
|
|
13 |
|
14 |
+
### Model Sources
|
15 |
|
16 |
+
- **Repository:** [amazon/chronos-t5-tiny](https://huggingface.co/amazon/chronos-t5-tiny)
|
17 |
+
- **Paper [optional]:** [Chronos: Learning the Language of Time Series](https://arxiv.org/abs/2403.07815)
|
18 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
19 |
|
20 |
## How to Get Started with the Model
|
21 |
|
22 |
+
TO BE ADDED
|
|
|
|
|
23 |
|
|
|
24 |
|
25 |
+
## Training Data
|
26 |
|
27 |
+
ALberta timeseries electricity load of 1-hour basis between 2017-2020
|
28 |
|
|
|
|
|
|
|
|
|
|
|
29 |
|
30 |
#### Preprocessing [optional]
|
31 |
|
32 |
+
TO BE ADDED
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
33 |
|
34 |
+
#### Metrics for evaluation
|
35 |
|
36 |
+
TO BE ADDED
|
37 |
|