voxel51 / fiftyone

The open-source tool for building high-quality datasets and computer vision models
https://fiftyone.ai
Apache License 2.0
8.09k stars 539 forks source link

[DOCS] Not clear that visualizer plugins can be used only for 3D datasets #4573

Open steve-zhivodkov-oxb opened 2 months ago

steve-zhivodkov-oxb commented 2 months ago

URL(s) with the issue

https://docs.voxel51.com/plugins/developing_plugins.html#component-types

Description of proposal (what needs changing)

The description of the visualizer plugin type might need to be clearer that it can only be used for 3D datasets.

From the docs:

  • Visualizer: JS plugins can register a component that will override the builtin Sample visualizer

It may make someone think it can be used for any sample visualizer, e.g. the image visualizer. However, only Sample3D component checks for active plugins: https://github.com/voxel51/fiftyone/blob/61afb2df03996c9d23d91d469278c741179ba1e3/app/packages/core/src/components/Modal/Sample3d.tsx#L20

Willingness to contribute

The FiftyOne Community encourages documentation contributions. Would you or another member of your organization be willing to contribute a fix for this documentation issue to the FiftyOne codebase?

benjaminpkane commented 3 weeks ago

HI @steve-zhivodkov-oxb we are addressing this. Stay tuned. Thanks!