ignite icon indicating copy to clipboard operation
ignite copied to clipboard

Update class.rst

Open ydcjeff opened this issue 3 years ago • 5 comments

Fixes #{issue number}

Description:

Check list:

  • [ ] New tests are added (if a new feature is added)
  • [ ] New doc strings: description and/or example code are in RST format
  • [ ] Documentation is updated (if required)

ydcjeff avatar Aug 06 '21 08:08 ydcjeff

Turns out that inherited members are not shown if we use .. automodule::.

ydcjeff avatar Aug 06 '21 09:08 ydcjeff

I checked Accuracy and it shows inherited methods:

  • https://deploy-preview-2143--pytorch-ignite-preview.netlify.app/generated/ignite.metrics.accuracy#ignite.metrics.Accuracy

vfdev-5 avatar Aug 06 '21 09:08 vfdev-5

But not in https://deploy-preview-2143--pytorch-ignite-preview.netlify.app/generated/ignite.contrib.handlers.tensorboard_logger.html#ignite.contrib.handlers.tensorboard_logger.TensorboardLogger

cuz that page is using .. automodule::.

Accuracy is using .. autoclass::

ydcjeff avatar Aug 06 '21 09:08 ydcjeff

Do we override automodule here: https://github.com/pytorch/ignite/blob/8148ce66329aaac14d0cc5dab8296878998f6115/docs/source/_templates/autosummary/module.rst ?

I do not understand the blocker, can give more details on why it does not work ?

vfdev-5 avatar Aug 06 '21 09:08 vfdev-5

I think because

ydcjeff avatar Aug 06 '21 10:08 ydcjeff