☄️ comet integration

[aniketmaurya]

Changes

Fixes #125

Type of change

• 📚 Documentation Update
• 🧪 Tests Cases
• 🐞 Bug fix (non-breaking change which fixes an issue)
• 🔬 New feature (non-breaking change which adds functionality)
• 🚨 Breaking change (fix or feature that would cause existing functionality to not work as expected)
• 📝 This change requires a documentation update

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• Did you update CHANGELOG in case of a major change?

[codecov]

Codecov Report

Merging #129 (1c203bd) into main (d8e3019) will decrease coverage by 0.10%.
The diff coverage is 90.90%.

@@            Coverage Diff             @@
##             main     #129      +/-   ##
==========================================
- Coverage   96.35%   96.24%   -0.11%     
==========================================
  Files          64       64              
  Lines        1838     1839       +1     
==========================================
- Hits         1771     1770       -1     
- Misses         67       69       +2     

Flag	Coverage Δ
unittests	96.24% <90.90%> (-0.11%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
gradsflow/core/base.py	100.00% <ø> (ø)
gradsflow/callbacks/gpu.py	93.75% <83.33%> (+0.41%)	⬆️
gradsflow/callbacks/logger/comet.py	96.36% <91.30%> (-3.64%)	⬇️
gradsflow/models/tracker.py	94.80% <100.00%> (-0.32%)	⬇️
tests/models/test_tracker.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d8e3019...1c203bd. Read the comment docs.

[mcullan]

Hi, ML Engineer at Comet here! This is looking great. There are a few things that come to mind, for me.

1. In CometCallback.__init__ , I would recommend adding an optional workspace argument that gets passed to comet_ml.Experiment/comet_ml.OfflineExperiment. Without a workspace argument, an experiment is placed in a user's default workspace, i.e. their username. See here: https://www.comet.ml/docs/python-sdk/Experiment/#experiment__init__
2. You may find it useful to allow for logging to an existing experiment using our ExistingExperiment class, if you think it would be suitable for working in Gradsflow. You could do this by adding an optional experiment_key argument to the initializer. For an example of implementation, check out Catalyst's Comet integration: https://github.com/catalyst-team/catalyst/blob/master/catalyst/loggers/comet.py . For more info on logging to existing experiments: https://www.comet.ml/docs/python-sdk/ExistingExperiment/

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[aniketmaurya]

Thank you for your time to review this @mcullan. I have applied your suggestions for both workspace and loading previous experiment. Thanks for the feedback!