Skip to content

Commit 3aa5c97

Browse files
add public function untrained_model() in docs (#2684)
* remove untrained_model from autodoc exclude-members * update changelog and untrained_model docs --------- Co-authored-by: dennisbader <[email protected]>
1 parent 534618f commit 3aa5c97

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ but cannot always guarantee backwards compatibility. Changes that may **break co
1111

1212
**Improved**
1313

14+
- Made method `ForecastingModel.untrained_model()` public. Use this method to get a new (untrained) model instance created with the same parameters. [#2684](https://github.com/unit8co/darts/pull/2684) by [Timon Erhart](https://github.com/turbotimon)
15+
1416
**Fixed**
1517

1618
**Dependencies**

darts/models/forecasting/forecasting_model.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -2601,7 +2601,7 @@ def _extract_model_creation_params(self):
26012601
return model_params
26022602

26032603
def untrained_model(self):
2604-
"""Returns a new (untrained) model instance create with the same parameters."""
2604+
"""Returns a new (untrained) model instance created with the same parameters."""
26052605
return self.__class__(**copy.deepcopy(self.model_params))
26062606

26072607
@property

docs/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
+ "PastCovariatesTorchModel,FutureCovariatesTorchModel,DualCovariatesTorchModel,MixedCovariatesTorchModel,"
5555
+ "SplitCovariatesTorchModel,"
5656
+ "min_train_series_length,"
57-
+ "untrained_model,first_prediction_index,future_covariate_series,past_covariate_series,"
57+
+ "first_prediction_index,future_covariate_series,past_covariate_series,"
5858
+ "initialize_encoders,register_datapipe_as_function,register_function,functions,"
5959
+ "SplitTimeSeriesSequence,randint,AnomalyModel",
6060
}

0 commit comments

Comments
 (0)