squlearn icon indicating copy to clipboard operation
squlearn copied to clipboard

adjust docstrings and type definitions for fit methods

Open DennisKleinhans opened this issue 1 year ago • 1 comments

To fit the doc style of sklearn:

  • removed the type definitions (np.ndarray) for X and y in the fit methods of the HLMs
  • added the same type hints for X and y as in sklearn:
    • X: array-like or sparse matrix of shape (n_samples, n_features)
    • y: array-like of shape (n_samples,)

DennisKleinhans avatar Aug 14 '24 15:08 DennisKleinhans

Can't tell what we decided:

X (array-like, sparse matrix): xxx

or

X:  array-like of shape (n_samples, n_features) ...

David-Kreplin avatar Aug 15 '24 15:08 David-Kreplin