Skip to content

Update docstrings for GemNetTDenoiser and dataset methods #134

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

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

Conversation

luisbro
Copy link

@luisbro luisbro commented Apr 11, 2025

Updates the docstrings of a few methods to match their input arguments.

Comment on lines +196 to +197
property_embeddings_adapt (torch.nn.ModuleDict, optional): Property embeddings used in
a conditioned model, fine-tuned from a base model. Unused here.
Copy link
Author

Choose a reason for hiding this comment

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

To me it seemed that property_embeddings_adapt is unused here and only used in the child class GemNetTAdapter, which handles the fine tuning, so I added the hint "unused here". It could probably be removed, but then one might also want to remove it from some yaml files and I wasn't too sure about it, so it just stuck to the hint instead of trying to remove it. Possibly the consistency to the other classes might be desireable.

@luisbro
Copy link
Author

luisbro commented Apr 11, 2025

@luisbro please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree

@luisbro luisbro force-pushed the update-docstrings branch from a120367 to 655a68e Compare April 24, 2025 11:36
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.

1 participant