neuralib.util.verbose.publish_annotation

neuralib.util.verbose.publish_annotation(level, *, project=None, figure=None, caption=None, as_doc=False, as_attributes=True)[source]

Annotation for knowing the class/function using scenario in paper publication

Parameters:

  • level (Literal['main', 'sup', 'appendix', 'test']) – {‘main’, ‘sup’, ‘appendix’, ‘test’}

  • project (str | list[str] | None) – Project name or list of project name

  • figure (str | list[str] | None) – Figure number or list of figure name

  • caption (str | None) – Other caption

  • as_doc (bool) – As documents, be able to parser the .. note:: block by Sphinx

  • as_attributes (bool) – If set info as attributes

Returns: