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

Logging #11

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Logging #11

wants to merge 12 commits into from

Conversation

umarteauowkin
Copy link
Collaborator

@umarteauowkin umarteauowkin commented Jan 22, 2025

What does your PR implement? Be specific.

This PR cleans the logging utilities of fedpydeseq2.
Logging is now configured using a configuration file, and is not performed by default. It is only performed in subprocess mode.
Moreover, we add the possibility to create a workflow file in subprocess mode (configured by the configuration file)
This file essentially logs the input and outputs of all remote and remote_data methods (it actually logs the keys of the dictionaries and their types and shapes), as well as when a for loop is used, and when we structure the calling to these remote/remote_data methods using organisation methods.

This PR also adds docformatter, hence the enormous number of changed files. Sorry about this.

Finally: I also modified the readmes and the docs to reflect these new features, even though they are honestly meant for developpers. Note that these features are tested.

I also simplified the test logic of processed data, to avoid, locally, to have to reprocess the data all the time.

@umarteauowkin umarteauowkin marked this pull request as ready for review January 22, 2025 17:41
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Real change : description of the test paths json.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Real change: add docformatter

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

adding this file to allow devs to fully install everything (testing datasets included)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Adding this file in the doc to describe how logging is handled

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Big change: the logging is activated only if the logging path points to a file that is not empty.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

  • utils to log iterations and organisation methods.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Readme on logging

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Adding 2 files to describe logging and install for devs including dataset download and logging config

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Adding docformatter

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Adding logging paths and simplifying processed_data -> either tmp if nothing is set in the paths.json or not if set (so that locally a user can avoid rebuilding the datasets all the time).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

New file to test logging with the workflow file.

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.

1 participant