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.

Sign up for GitHub

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

Jump to bottom

Create overviews of inputs outputs #698

Merged
merged 5 commits into from
Feb 5, 2024
Merged

Create overviews of inputs outputs #698

merged 5 commits into from
Feb 5, 2024

Conversation

SarahAlidoost
Copy link
Contributor

@SarahAlidoost SarahAlidoost commented Jan 24, 2024 •
edited
Loading

closes #663
relates #691
preview here.

@SarahAlidoost SarahAlidoost marked this pull request as ready for review January 26, 2024 11:34
@SarahAlidoost
Copy link
Contributor Author

@elboyran I prepared tables listing input/output of methods/functions. I found most of them in either API documentation or the source code. Others like Dims/shape or some value ranges cannot be found in the doc. Please have a look at this PR and let me know if it can be further improved.

@elboyran
Copy link
Contributor

again some notebooks are failing... @cpranav93 what was the trick?

elboyran
elboyran reviewed Jan 27, 2024
View reviewed changes
Copy link
Contributor

@elboyran elboyran left a comment

Choose a reason for hiding this comment

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

Very nice job, Sarah!
The most tedious part is left and that is the dimensions and shapes as for that one needs to look inside the code. Any ideas how to make it quickly, maybe partially is enough?

@SarahAlidoost
Copy link
Contributor Author

SarahAlidoost commented Jan 30, 2024 •
edited
Loading

Very nice job, Sarah! The most tedious part is left and that is the dimensions and shapes as for that one needs to look inside the code. Any ideas how to make it quickly, maybe partially is enough?

@elboyran Thank you for reviewing and for your comments. As we discussed, the difference in dimensions and shapes of outputs can be already seen in the Type columns in the output tables. As I fix issue #640, I will also update this document. If you think we can merge this PR, can you please approve it?

@elboyran elboyran self-requested a review February 2, 2024 13:45
elboyran
elboyran approved these changes Feb 2, 2024
View reviewed changes
Copy link
Contributor

@elboyran elboyran left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Good job. Please, merge.

@SarahAlidoost SarahAlidoost merged commit 887f654 into main Feb 5, 2024
27 checks passed
@SarahAlidoost SarahAlidoost deleted the add_overview branch February 5, 2024 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elboyran elboyran elboyran approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create an overview (table?) of all input types and output types (including dimension names)
2 participants
@SarahAlidoost @elboyran