Update outdated docstring for X and Y

Close #37

stepmix/bootstrap.py

@@ -55,22 +55,18 @@ def bootstrap(
     ----------
     estimator : StepMix instance
         A fitted StepMix estimator. Used as a template to clone bootstrap estimator.
-    X : array-like of shape (n_samples, n_columns)
-        Measurement data.
-    Y : array-like of shape (n_samples, n_columns_structural), default=None
-        Structural data.
+    X : array-like of shape (n_samples, n_features)
+    Y : array-like of shape (n_samples, n_features_structural), default=None
     n_repetitions: int
         Number of repetitions to fit.
     sample_weight : array-like of shape(n_samples,), default=None
-        Array of weights that are assigned to individual samples.
-        If not provided, then each sample is given unit weight.
     progress_bar : bool, default=True
         Display a tqdm progress bar for repetitions.
     Returns
     ----------
     parameters: DataFrame
         DataFrame of all repetitions. Follows the convention of StepMix.get_parameters_df() with an additional
-        'rep' index.
+        'rep' column.
     stats: DataFrame
         Various statistics of bootstrapped estimators.
     """

stepmix/emission/emission.py

@@ -70,7 +70,7 @@ def initialize(self, X, resp, random_state=None):
 
         Parameters
         ----------
-        X : ndarray of shape (n_samples, n_columns)
+        X : ndarray of shape (n_samples, n_features)
             Input data for this emission model.
         resp : ndarray of shape (n_samples, n_components)
             Responsibilities, i.e., posterior probabilities over the latent classes.
@@ -112,7 +112,7 @@ def m_step(self, X, resp):
 
         Parameters
         ----------
-        X : ndarray of shape (n_samples, n_columns)
+        X : ndarray of shape (n_samples, n_features)
             Input data for this emission model.
         resp : ndarray of shape (n_samples, n_components)
             Responsibilities, i.e., posterior probabilities over the latent classes of each point in X.
@@ -212,6 +212,8 @@ def print_parameters(
     def get_parameters_df(self, feature_names=None):
         """Return self.parameters into a long dataframe.
 
+        Columns should be ["model_name", "param", "class_no", "variable", "value"].
+
         Call self._to_df or implement custom method."""
         return self._to_df(
             param_dict=self.parameters,