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

comet_ml logger update #20275

Open
wants to merge 26 commits into
base: master
Choose a base branch
from

Conversation

japdubengsub
Copy link

@japdubengsub japdubengsub commented Sep 11, 2024

What does this PR do?

Hi, this is the PR from Comet's SDK engineer.
In this pull request, the CometML logger was updated to support the recent Comet SDK. Also:

  • unified with the comet_ml.start() method to ensure ease of use
  • removed deprecated REST API key
  • enabled support for nested hyper parameters
  • backward compatibility with previous versions has been maintained.
Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

📚 Documentation preview 📚: https://pytorch-lightning--20275.org.readthedocs.build/en/20275/

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Sep 11, 2024
Copy link

@RahulVadisetty91 RahulVadisetty91 left a comment

Choose a reason for hiding this comment

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

w5

Before mocking, ensure these methods exist or update the test logic to mock accessible methods or properties. You might also want to log or assert that these attributes are successfully mocked to catch any potential issues during runtime.

@japdubengsub
Copy link
Author

Hi everyone! In the latest commit, I fixed a couple of unit tests related to the changes in this branch. If there's anything else that needs to be adjusted, please let me know.

@Ritesh313
Copy link

Hi @japdubengsub I want to try out this new branch and having trouble getting it to work (getting errors at trainer.fit() step). Could you confirm if i'm installing the right branch:
pip install git+https://github.com/comet-ml/pytorch-lightning.git@feature/comet-logger-update

@japdubengsub
Copy link
Author

Hi @Ritesh313!
Thank you for the feedback! Yes, the branch is correct. In recent commits, the fix for this error and support for the old experiment_name parameter were added.

rest_api_key=os.environ.get("COMET_REST_API_KEY"), # Optional
experiment_key=os.environ.get("COMET_EXPERIMENT_KEY"), # Optional
experiment_name="lightning_logs", # Optional
api_key="COMET_API_KEY", # Optional
Copy link
Member

Choose a reason for hiding this comment

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

why not os.environ.get() any more
these default seems strange, then rather None

Copy link
Author

Choose a reason for hiding this comment

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

My intention here was to simplify the example of passing parameters, as if the parameters are already set as environment variables, they don't need to be specified—they'll be automatically picked up. However, if you believe it's clearer as it was before, I can revert the changes.

file but still want to run offline experiments.
prefix: A string to put at the beginning of metric keys.
\**kwargs: Additional arguments like `workspace`, `log_code`, etc. used by
api_key (str, optional): Comet API key. It's recommended to configure the API Key with `comet login`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
api_key (str, optional): Comet API key. It's recommended to configure the API Key with `comet login`.
api_key: Comet API key. It's recommended to configure the API Key with `comet login`.

please remove all typing here as it is already used from function footprint

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants