Skip to content

Commit ef16171

Browse files
authored
Add docs about the patameters (#771)
1 parent d087054 commit ef16171

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

qlib/data/dataset/processor.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,8 @@ def __call__(self, df):
197197

198198
class MinMaxNorm(Processor):
199199
def __init__(self, fit_start_time, fit_end_time, fields_group=None):
200+
# NOTE: correctly set the `fit_start_time` and `fit_end_time` is very important !!!
201+
# `fit_end_time` **must not** include any information from the test data!!!
200202
self.fit_start_time = fit_start_time
201203
self.fit_end_time = fit_end_time
202204
self.fields_group = fields_group
@@ -226,6 +228,8 @@ class ZScoreNorm(Processor):
226228
"""ZScore Normalization"""
227229

228230
def __init__(self, fit_start_time, fit_end_time, fields_group=None):
231+
# NOTE: correctly set the `fit_start_time` and `fit_end_time` is very important !!!
232+
# `fit_end_time` **must not** include any information from the test data!!!
229233
self.fit_start_time = fit_start_time
230234
self.fit_end_time = fit_end_time
231235
self.fields_group = fields_group
@@ -263,6 +267,8 @@ class RobustZScoreNorm(Processor):
263267
"""
264268

265269
def __init__(self, fit_start_time, fit_end_time, fields_group=None, clip_outlier=True):
270+
# NOTE: correctly set the `fit_start_time` and `fit_end_time` is very important !!!
271+
# `fit_end_time` **must not** include any information from the test data!!!
266272
self.fit_start_time = fit_start_time
267273
self.fit_end_time = fit_end_time
268274
self.fields_group = fields_group

0 commit comments

Comments
 (0)