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

Docs PCA #115

Merged
merged 3 commits into from
Jan 26, 2025
Merged

Docs PCA #115

merged 3 commits into from
Jan 26, 2025

Conversation

hankunxiao
Copy link
Collaborator

No description provided.

@hankunxiao hankunxiao added this to the Milestone 3 milestone Jan 24, 2025
@hankunxiao hankunxiao self-assigned this Jan 24, 2025
@hankunxiao hankunxiao linked an issue Jan 24, 2025 that may be closed by this pull request
@hankunxiao hankunxiao changed the title add documentation Docs PCA Jan 24, 2025
Copy link
Collaborator

@Arc-Celt Arc-Celt left a comment

Choose a reason for hiding this comment

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

Good job for the examples! A few suggestions:

  1. Maybe you can use the sample image from scikit-image because that's what the other tutorials did. So that our documentation can be coherent and consistent.
  2. Also just like the other tutorials, you can add some notes for attention in between the chunks and have some final remarks (congrats or something). To make the tutorial clear and friendly to the users.

@hankunxiao
Copy link
Collaborator Author

@Arc-Celt great suggestions! I have updated the notebook correspondingly. You can find them in the latest commit.

@Arc-Celt Arc-Celt self-requested a review January 26, 2025 06:32
Copy link
Collaborator

@Arc-Celt Arc-Celt left a comment

Choose a reason for hiding this comment

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

Both the notebook and the rendered html looks great. Good job and thanks for adding the details! Should be OK to be merged.

@hankunxiao hankunxiao merged commit 83f1d8d into main Jan 26, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add documentation for the tutorial part of function pca_compression
2 participants