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

Add log readme #664

Merged
merged 21 commits into from
Feb 1, 2023
Merged

Add log readme #664

merged 21 commits into from
Feb 1, 2023

Conversation

Louis-Dupont
Copy link
Contributor

No description provided.

@dagshub
Copy link

dagshub bot commented Jan 29, 2023

Copy link
Collaborator

@shaydeci shaydeci left a comment

Choose a reason for hiding this comment

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

I feel like this is missing quite a lot of what we are aiming for...

All we do here is flash some parameters to integrate WandB and Clearml, when I think the appropriate thing to do here is to explain about SG loggers, detailing how one can access their methods (phase callbacks).

Also, there's quite a lot to say on what values we log by default, what values we print etc.
Don't forget about Tensorboards too.

I think there's quite a lot to detail about regarding training with configs- there's the .hydra directory, the "recipe_config" which is logged when using train_from_config (and if we are already talking about additional logs- additional_logs that one can pass through train() is not mentioned here either).

Copy link
Collaborator

@ofrimasad ofrimasad left a comment

Choose a reason for hiding this comment

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

Please note that the SGLoggers should be on a different document (Monitoring). copy them to another document.
missing in this file are the different types of logs and what is in each one of them.

  • console_.txt
  • log_.txt
  • sg_logs_.txt
    Also, how to set a different log level
    Crash tips and how to turn them off

documentation/source/Logs.md Outdated Show resolved Hide resolved
documentation/source/Logs.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@ofrimasad ofrimasad left a comment

Choose a reason for hiding this comment

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

Beautiful documentation!
just remove the code that was already pushed in the second PR please.
see my minor comment inline

documentation/source/logs.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@ofrimasad ofrimasad left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@shaydeci shaydeci left a comment

Choose a reason for hiding this comment

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

LGTM

@shaydeci shaydeci merged commit 627ab20 into master Feb 1, 2023
@shaydeci shaydeci deleted the feature/SG-610-document_log_prints branch February 1, 2023 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants