chanzuckerberg / cellxgene-census

CZ CELLxGENE Discover Census
https://chanzuckerberg.github.io/cellxgene-census/
MIT License
84 stars 22 forks source link

Add logging output throughout Census API #504

Open atolopko-czi opened 1 year ago

atolopko-czi commented 1 year ago

Assess classes and methods that could benefit from providing log output to aid developers making use of the API. Use debug, warn, or info levels, as appropriate.

Consider that both _open and experimental.ml.pytorch modules have introduced usage of logging. Introducing a convenience method for initializing logging would be useful, similar to what the builder package has done in cellxgene_census_builder.logging.logging_init.

The builder package could also use a review of its logging output, to assess its comprehensiveness and consistency of output messages.

pablo-gar commented 1 year ago

@atolopko-czi can you provide a sense of the impact of this ticket? Is it currently a blocker for you? Are there any cases where this would be great to have?

pablo-gar commented 1 year ago

From @atolopko-czi

The intent of the issue was to take the logging setup from PyTorch and use it more liberally throughout the API, so developers (i.e. users of the API) can output debug-level info to help troubleshoot (or understand) what's happening internally.