fix: update comet_ml logger for compatibility

[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]

@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 82.81250% with 11 lines in your changes missing coverage. Please review.

Project coverage is 79%. Comparing base (a0134d2) to head (9e7a3cc).
Report is 2 commits behind head on master.

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

HEAD has 321 uploads less than BASE

Flag	BASE (a0134d2)	HEAD (9e7a3cc)
cpu	96	24
lightning	61	15
pytest	51	0
python3.11	24	6
python3.10	24	6
python	12	3
lightning_fabric	20	0
gpu	3	0
python3.12.7	36	9
pytorch2.1	12	6
pytorch_lightning	18	9
pytest-full	48	24
pytorch2.2.2	6	3
pytorch2.5	6	3
pytorch2.3	6	3
pytorch2.4.1	6	3
pytorch2.5.1	6	3
pytorch2.6	6	3

Additional details and impacted files

@@            Coverage Diff            @@
##           master   #20275     +/-   ##
=========================================
- Coverage      88%      79%     -9%     
=========================================
  Files         267      264      -3     
  Lines       23373    23301     -72     
=========================================
- Hits        20483    18348   -2135     
- Misses       2890     4953   +2063     

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Borda]

@japdubengsub sees we cannot edit this PR, so could you please run the linter? 🐿️

[japdubengsub]

@japdubengsub sees we cannot edit this PR, so could you please run the linter? 🐿️

@Borda Good afternoon!

Thanks a lot for the feedback. I’ve made the following updates:

• Merged the latest master.
• Resolved merge conflict.
• Fixed linter errors.
• Resolved errors in the logger tests.

There’s also one mypy error (see below).

src/lightning/pytorch/core/module.py:1405: error: Unused "type: ignore" comment  [unused-ignore]
Found 1 error in 1 file (checked 263 source files)

It doesn’t seem to be related to the logger, so I left it as is.

[NellyWhads]

Hey guys! Which lightning release can we expect this to be a part of?