Skip to content

Commit 110dfd9

Browse files
Fixing docstring (#228)
* fixing outdated docstring * fixing outdated docstring
1 parent 9999e0f commit 110dfd9

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

pymc_experimental/model_builder.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -187,14 +187,17 @@ def default_sampler_config(self) -> Dict:
187187
raise NotImplementedError
188188

189189
@abstractmethod
190-
def generate_and_preprocess_model_data(
190+
def _generate_and_preprocess_model_data(
191191
self, X: Union[pd.DataFrame, pd.Series], y: pd.Series
192192
) -> None:
193193
"""
194194
Applies preprocessing to the data before fitting the model.
195195
if validate is True, it will check if the data is valid for the model.
196196
sets self.model_coords based on provided dataset
197197
198+
In case of optional parameters being passed into the model, this method should implement the conditional
199+
logic responsible for correct handling of the optional parameters, and including them into the dataset.
200+
198201
Parameters:
199202
X : array, shape (n_obs, n_features)
200203
y : array, shape (n_obs,)
@@ -203,10 +206,9 @@ def generate_and_preprocess_model_data(
203206
--------
204207
>>> @classmethod
205208
>>> def generate_and_preprocess_model_data(self, X, y):
206-
>>> x = np.linspace(start=1, stop=50, num=100)
207-
>>> y = 5 * x + 3 + np.random.normal(0, 1, len(x)) * np.random.rand(100)*10 + np.random.rand(100)*6.4
208-
>>> X = pd.DataFrame(x, columns=['x'])
209-
>>> y = pd.Series(y, name='y')
209+
coords = {
210+
'x_dim': X.dim_variable,
211+
} #only include if applicable for your model
210212
>>> self.X = X
211213
>>> self.y = y
212214

0 commit comments

Comments
 (0)