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

Improvements to aydin docstrings #110

Merged
merged 6 commits into from
Mar 22, 2022

Conversation

royerloic
Copy link
Member

Improved a lot of doc-strings, particularly for feature gen and FGR backends.

@royerloic royerloic self-assigned this Mar 12, 2022
Copy link
Collaborator

@AhmetCanSolak AhmetCanSolak left a comment

Choose a reason for hiding this comment

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

Thank you @royerloic ! I dropped a few comments to discuss if we can add further more info on certain places. After discussing these I think we can merge this. After the merge I will be making a follow-up PR to address changes on our documentation too and will update documentation webpage accordingly.

aydin/features/groups/uniform.py Outdated Show resolved Hide resolved
@@ -43,8 +43,10 @@ def __init__(
balance_training_data : bool
Limits number training entries per target
value histogram bin.
(advanced)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I found myself toggling balance_training_data quite often while using Aydin. With certain images it helps a ton. Maybe we don't make it (advanced)? What do you think @royerloic ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good idea! It is actually an important feature!

aydin/regression/perceptron.py Show resolved Hide resolved
Copy link
Collaborator

@AhmetCanSolak AhmetCanSolak left a comment

Choose a reason for hiding this comment

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

Thank you for the updates. Looks great. Now merging!

@AhmetCanSolak AhmetCanSolak merged commit 0413666 into royerlab:master Mar 22, 2022
@royerloic royerloic deleted the feature_gen_docs branch May 23, 2022 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants