comet_ml logger update

[japdubengsub]

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/

[RahulVadisetty91]

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]

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]

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]

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.

[japdubengsub]

@Borda
@RahulVadisetty91
Hi!
I’ve fixed all the tests related to my changes, as well as some that might be affected by changes to CometLogger but aren’t directly related to my updates.
However, I still see a few tests failing that, as far as I can tell, shouldn’t be affected by changes in this PR. Could you please check them and let me know if there’s anything else I should fix? I’d be happy to do so.
Thanks!

[japdubengsub]

@Borda @ethanwharris

Hi Lightning team!
Sorry to bother you again, but could you please take another look at this pull request?
Thanks in advance!

[Borda]

Hi Lightning team! Sorry to bother you again, but could you please take another look at this pull request? Thanks in advance!

Cc @lantiga

[codecov]

Codecov Report

Attention: Patch coverage is 81.96721% with 11 lines in your changes missing coverage. Please review.

Project coverage is 79%. Comparing base (be608fa) to head (dc048b1).

❗ There is a different number of reports uploaded between BASE (be608fa) and HEAD (dc048b1). Click for more details.

HEAD has 547 uploads less than BASE

Flag	BASE (be608fa)	HEAD (dc048b1)
cpu	146	23
lightning_fabric	21	0
pytest	76	0
python3.9	36	6
lightning	109	17
python3.11	36	6
python3.10	19	3
gpu	2	0
python3.12	55	8
pytorch2.1	27	9
pytest-full	72	23
pytorch_lightning	18	6
pytorch2.2.2	9	3
pytorch2.3	9	3
pytorch2.5.1	18	6
pytorch2.4.1	9	2

Additional details and impacted files

@@            Coverage Diff            @@
##           master   #20275     +/-   ##
=========================================
- Coverage      88%      79%     -9%     
=========================================
  Files         267      264      -3     
  Lines       23276    23201     -75     
=========================================
- Hits        20383    18245   -2138     
- Misses       2893     4956   +2063