Skip to content

Clean docstrings of algo fit #329

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

Merged
merged 2 commits into from
Mar 5, 2025

Conversation

caglayantuna
Copy link

This PR updates docstrings of algo/fit files as it is mentioned in issue #122. I checked the doc locally and it seems ok to me. Also, I corrected minor things in dag.py file related to docstrings.

Copy link
Member

@NicolasGensollen NicolasGensollen left a comment

Choose a reason for hiding this comment

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

Thanks @caglayantuna !

LGTM, just a couple minor suggestions.

@@ -198,64 +202,15 @@ def _initialize_algo(self, model: AbstractModel, dataset: Dataset) -> State:

return state

def _terminate_algo(
Copy link
Member

Choose a reason for hiding this comment

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

I thought we deleted this already, didn't we ?

Copy link
Author

Choose a reason for hiding this comment

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

I opened a second PR and closed previous one when I am working on it. It seems that I forgot to delete it in the second PR. So, it is time remove it because it is useless

Copy link
Member

Choose a reason for hiding this comment

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

OK, thanks for the explanation.

apply suggestions

Co-authored-by: Gensollen <nicolas.gensollen@gmail.com>
Copy link
Member

@NicolasGensollen NicolasGensollen left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @caglayantuna !

@@ -198,64 +202,15 @@ def _initialize_algo(self, model: AbstractModel, dataset: Dataset) -> State:

return state

def _terminate_algo(
Copy link
Member

Choose a reason for hiding this comment

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

OK, thanks for the explanation.

@NicolasGensollen NicolasGensollen merged commit f5e5c50 into aramis-lab:v2 Mar 5, 2025
9 checks passed
@caglayantuna caglayantuna deleted the clean_algo branch March 6, 2025 13:39
@NicolasGensollen NicolasGensollen mentioned this pull request Mar 7, 2025
36 tasks
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