ashpy
ashpy copied to clipboard
[DOC] - ashpy.utils is not part of the API reference
Self explanatory ashpy.utils
is missing from the API reference.
Should we add it to the API reference? utils is not imported in the ashpy/__init__.py
. They are two internals method.
@mr-ubik @galeone @iLeW ping
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.
I am in complete agreement with @galeone.
Name of the package containing the log method.
Options:
ashpy.tensorboard ashpy.logging
This is a hard choice. 🤔 I would probably go with ashpy.tensorboard
. since usually logging is used for referring CLI/console logging.