adjust docstrings and type definitions for fit methods

sQUlearn / squlearn

scikit-learn interface for quantum algorithms

https://squlearn.github.io

Apache License 2.0

63 stars 20 forks source link

Closed DennisKleinhans closed 2 months ago

DennisKleinhans commented 3 months ago

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,)

David-Kreplin commented 3 months ago

Can't tell what we decided:

X (array-like, sparse matrix): xxx

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