Skip to content

Comet Integration #1283

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 15 commits into from
Sep 1, 2021
Merged

Comet Integration #1283

merged 15 commits into from
Sep 1, 2021

Conversation

DN6
Copy link
Contributor

@DN6 DN6 commented Aug 28, 2021 •
edited
Loading

Before submitting (checklist)

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • Did you read the contribution guide?
  • Did you check the code style? catalyst-make-codestyle && catalyst-check-codestyle (pip install -U catalyst-codestyle).
  • Did you make sure to update the docs? We use Google format for all the methods and classes.
  • Did you check the docs with make check-docs?
  • Did you write any new necessary tests?
  • Did you check that your code passes the unit tests pytest . ?
  • Did you add your new functionality to the docs?
  • Did you update the CHANGELOG?
  • Did you run colab minimal CI/CD with latest and minimal requirements?
  • Did you check XLA integration with single and multiple processes?

Description

This PR adds the option to log metrics, parameters and any other type of data asset to Comet

Related Issue

Type of Change

  • Examples / docs / tutorials / contributors update
  • Bug fix (non-breaking change which fixes an issue)
  • Improvement (non-breaking change which improves an existing feature)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

FAQ

Please review the FAQ before submitting an issue:

@DN6 DN6 requested review from bagxi, ditwoo and Scitator as code owners August 28, 2021 13:16
@pep8speaks
Copy link

pep8speaks commented Aug 28, 2021 •
edited
Loading

Hello @DN6! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-08-31 20:39:09 UTC

@DN6
Copy link
Contributor Author

DN6 commented Aug 28, 2021 •
edited
Loading

Hi @Scitator. I think I've addressed all the code style issues, run the pre-commit hooks, and the docs tests. They all seem to be passing. I'm still not able to see the CometLogger when I render the docs page though. Let me know if I missed something.

Podidiving
Podidiving reviewed Aug 28, 2021
View reviewed changes
catalyst/loggers/comet.py Outdated
Config API example:
.. code-block:: yaml
loggers:
neptune:
Copy link
Contributor

Choose a reason for hiding this comment

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

Forgot to rename it

Podidiving
Podidiving reviewed Aug 28, 2021
View reviewed changes
catalyst/loggers/comet.py Outdated
Hydra API example:
.. code-block:: yaml
loggers:
neptune:
Copy link
Contributor

Choose a reason for hiding this comment

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

Forgot to rename it

Podidiving
Podidiving reviewed Aug 28, 2021
View reviewed changes
catalyst/loggers/comet.py Outdated
...
loggers={
"comet": dl.CometLogger(
project_name="my-comet-project
Copy link
Contributor

Choose a reason for hiding this comment

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

missing "

Podidiving
Podidiving reviewed Aug 28, 2021
View reviewed changes
catalyst/loggers/comet.py Outdated
comet_mode: str = "online",
tags: List = None,
logging_frequency: int = 1,
**experiment_kwargs,
Copy link
Contributor

Choose a reason for hiding this comment

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

mb add api_key as an explicit parameter?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @Podidiving, generally we recommend users set their API Key either as an environment variable or in a comet.config file on their machine.

@Scitator
Copy link
Member

Hi @DN6 ,
For the docs support, you should also update https://github.com/catalyst-team/catalyst/blob/master/docs/api/loggers.rst ;)

@Scitator
Copy link
Member

waiting for the docs and codestyle and ready to merge 🚀

@DN6
Copy link
Contributor Author

DN6 commented Aug 31, 2021

@Scitator @Podidiving I've cleaned up the docstrings, added the Comet Logger information to the docs and I run the codestyle pre-commit hooks again.

Additionally, we've prepared a tutorial Colab Notebook for anyone to test out the integration here. Would it be possible to include it somewhere in the README (Maybe under Examples, Notebooks, and Starter Kits)?

@Scitator
Copy link
Member

Scitator commented Sep 1, 2021

@DN6 could you please check the codestyle?

@DN6
Copy link
Contributor Author

DN6 commented Sep 1, 2021

@Scitator Done. Checked with the Colab CI/CD tool and it seems like it's passing. Output from
! cat ./catalyst/codestyle.txt

Skipped 58 files
0

For the example notebook, should I open up a separate PR or add to this one?

@Scitator Scitator merged commit 03c66f4 into catalyst-team:master Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bagxi bagxi Awaiting requested review from bagxi bagxi is a code owner

@ditwoo ditwoo Awaiting requested review from ditwoo

@Scitator Scitator Awaiting requested review from Scitator Scitator is a code owner

1 more reviewer

@Podidiving Podidiving Podidiving left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@DN6 @pep8speaks @Scitator @Podidiving