ashpy icon indicating copy to clipboard operation
ashpy copied to clipboard

[DOC] - ashpy.utils is not part of the API reference

Open mr-ubik opened this issue 4 years ago • 6 comments

Self explanatory ashpy.utilsis missing from the API reference.

mr-ubik avatar Apr 01 '20 19:04 mr-ubik

Should we add it to the API reference? utils is not imported in the ashpy/__init__.py. They are two internals method.

EmanueleGhelfi avatar Apr 02 '20 10:04 EmanueleGhelfi

@mr-ubik @galeone @iLeW ping

EmanueleGhelfi avatar Apr 06 '20 06:04 EmanueleGhelfi

The log method (in utils) is extremely useful when doing custom logging, it should be documented and public; perhaps moved in a better location.

The validate_objects instead is too broad, is not ashpy related and it can be left private and in this broad ("utils") package.

galeone avatar Apr 06 '20 06:04 galeone

I am in complete agreement with @galeone.

mr-ubik avatar Apr 07 '20 09:04 mr-ubik

Name of the package containing the log method.

Options:

ashpy.tensorboard ashpy.logging

EmanueleGhelfi avatar Apr 07 '20 10:04 EmanueleGhelfi

This is a hard choice. 🤔 I would probably go with ashpy.tensorboard. since usually logging is used for referring CLI/console logging.

mr-ubik avatar Apr 07 '20 17:04 mr-ubik