Skip to content

adjust docstrings and type definitions for fit methods#289

Merged
David-Kreplin merged 3 commits intosQUlearn:developfrom
DennisKleinhans:adjust_HLM_docstrings_and_typing
Sep 6, 2024
Merged

adjust docstrings and type definitions for fit methods#289
David-Kreplin merged 3 commits intosQUlearn:developfrom
DennisKleinhans:adjust_HLM_docstrings_and_typing

Conversation

@DennisKleinhans
Copy link
Collaborator

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

Copy link
Collaborator

@David-Kreplin David-Kreplin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!
Could you please add the docstrings at the qnnr and qnnc code.
They have been missing in the first place...

@David-Kreplin
Copy link
Collaborator

Can't tell what we decided:

X (array-like, sparse matrix): xxx

or

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

@David-Kreplin David-Kreplin merged commit c41e47d into sQUlearn:develop Sep 6, 2024
@DennisKleinhans DennisKleinhans deleted the adjust_HLM_docstrings_and_typing branch September 9, 2024 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants