Documentation for Implicitron

[sinAshish]

🚀 Feature

The documentation for the rest of the library is great and easy to follow. However, for Implicitron contains only the templates, and no additional info about the arguments or return parameters. Is this in the roadmap to improve the documentation for Implicitron?

NOTE: Please look at the existing list of Issues tagged with the label 'enhancement`. Only open a new issue if you do not see your feature request there.

Motivation

The documentation is practically non-existent and no way to figure out what the objective of each function/class is, making it difficult for novices in neural fields to leverage it in their works.

Pitch

A minimal description of the functions defined in Implicitron: arguments type, return types, with minimal code examples showing how to use them. If not for all all the functions, then atleast for the ones that are used most frequently in a neural fields related project.

NOTE: we only consider adding new features if they are useful for many users.

[bottler]

There's quite a lot of documented classes in implicitron, including the important ones I think, and also documentation in the implicitron trainer readme. Can you suggest some specific classes which it would be important to document better?

I see much of it is not appearing on readthedocs - I want to find out why that is.

[sinAshish]

yeah the documentation is not appearing on readthedocs. I notice that docs for only tools class is there. But it would be great if these had as well:

• implicitron.models.implicit_function
• implicitron.models.renderer.{sampler/marcher/tracer}
• implicitron.models.visualization

[sinAshish]

I notice that the documentation for these exist but are in pytorch3d.renderer

[bottler]

For implicitron e.g. those things, you should ignore readthedocs, and look at the documentation in the code or on github.

The implicit functions which have documentation at https://pytorch3d.readthedocs.io/en/latest/modules/renderer/index.html are in pytorch3d.renderer. They are more basic things than implicitron, and some of them are used by implicitron.

[sinAshish]

Oh I see. Then we really need the documentation for pytorch3d.implicitron.

[bottler]

Sorry about that. Just don't rely on readthedocs? It should be easy to read the documentation on github by clicking on the relevant files.