Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup check_*_domain utils #4

Closed
kachayev opened this issue Nov 21, 2023 · 1 comment
Closed

Cleanup check_*_domain utils #4

kachayev opened this issue Nov 21, 2023 · 1 comment

Comments

@kachayev
Copy link
Collaborator

kachayev commented Nov 21, 2023

The functions are already present in the code, so you can review them to understand their purposes. Given that they contain a significant number of internal clauses, it might be more straightforward to comprehend their functionality by reading the code directly.

  • check_X_y_domain [link]
  • check_X_domain [link]

The overall purpose of these functions is similar to the check_array function in sklearn. Depending on the provided flags, they can execute a wide range of checks. In our case, it’s crucial to ensure that all the checks are: a) necessary, meaning they make sense and are utilized in the code; b) implemented correctly, which we can verify by creating test cases for each check; and c) properly documented in the docstrings, with sklearn serving as an excellent reference for how to structure these. Additionally, we need to relocate these functions to a publicly accessible utils.py module, as they are intended for both internal use and external use (by anyone developing their own estimators).

@YanisLalou
Copy link
Collaborator

PR #53

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants