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

Comment correlation algorithm. #369

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

harveydevereux
Copy link
Collaborator

@harveydevereux harveydevereux self-assigned this Dec 12, 2024
@ElliottKasoar ElliottKasoar added the documentation Improvements or additions to documentation label Dec 13, 2024
Copy link
Member

@ElliottKasoar ElliottKasoar left a comment

Choose a reason for hiding this comment

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

Minor comment, but otherwise I think this looks good!

We probably want to change the title slightly to reflect the code changes, since it's not just changes to the docs.

Comment on lines +51 to 56
# Number of resoluion levels.
self._blocks = blocks
# Data points at each resolution.
self._points = points
# Coarse-graining between resolution levels.
self._averaging = averaging
Copy link
Member

@ElliottKasoar ElliottKasoar Dec 13, 2024

Choose a reason for hiding this comment

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

These can probably be merged into the parameter descriptions just above.

I'm also wondering if, similarly, rather than comments for the others, we could add an Attributes section (which includes all these hidden attributes).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants