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

Documented remaining Attributes of classes and functions #1239

Closed
wants to merge 23 commits into from
Closed

Documented remaining Attributes of classes and functions #1239

wants to merge 23 commits into from

Conversation

v-parmar
Copy link
Contributor

Reference Issue

#716

What does this PR implement/fix? Explain your changes.

I have added the missing documentation for attributes of classes and functions.

v-parmar and others added 14 commits March 28, 2023 01:19
added missing documentation
added missing documentation
added missing documentation
added missing documentation
added missing documentation
added missing documentation
added missing documentation
added missing documentation
added missing documentation
added missing documentation
added missing documentation
Added warning to run_model_on_task to avoid duplicates if no authentication
openml/flows/functions.py Outdated Show resolved Hide resolved
openml/runs/functions.py Outdated Show resolved Hide resolved
openml/runs/functions.py Outdated Show resolved Hide resolved
openml/runs/functions.py Outdated Show resolved Hide resolved
openml/runs/functions.py Outdated Show resolved Hide resolved
openml/study/functions.py Outdated Show resolved Hide resolved
openml/tasks/functions.py Outdated Show resolved Hide resolved
NotImplementedError
This method is not implemented yet.

"""
raise NotImplementedError()

def get(self, repeat=0, fold=0, sample=0):
Copy link
Contributor

Choose a reason for hiding this comment

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

add typing hints here and return type

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you provide a hint for adding typing?

@@ -36,14 +36,24 @@ class OpenMLTask(OpenMLBase):

Parameters
----------
task_id : Optional[int]
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the typing below is incorrect. This should be Union[int, None] (if possible) as it is not an optional parameter for this constructor. Hence, I would change it here and below to reflect this.

openml/tasks/task.py Outdated Show resolved Hide resolved
@mfeurer
Copy link
Collaborator

mfeurer commented Apr 17, 2023

Hey @v-parmar thank you very much for your contribution. Could you please have a look at the suggestions from @LennartPurucker so that we can potentially merge your updates?

Copy link
Contributor Author

@v-parmar v-parmar left a comment

Choose a reason for hiding this comment

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

Suggested changes are done.

@LennartPurucker
Copy link
Contributor

Again, thank you @v-parmar!
I looked through the changes and have added new comments above.

@v-parmar
Copy link
Contributor Author

@LennartPurucker, By mistake I have deleted so many files from my PR, so can I close this pull request and open a new pull request and make all these updates in it, will it work?

@v-parmar v-parmar closed this by deleting the head repository Apr 18, 2023
@LennartPurucker
Copy link
Contributor

LennartPurucker commented Apr 18, 2023

@v-parmar, that sounds like a good idea, I will look for the new PR and comment on it. But make sure to include your most recent changes, thank you!

@v-parmar
Copy link
Contributor Author

Sure. Thank you

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.

3 participants