facebookresearch/d2go

Can we start creating standard docs for this package?

GeorgePearse opened this issue ยท 4 comments


๐Ÿš€ Feature

Separate docs website, or much more detail in readmes throughout the website.

Motivation & Examples

Tell us why the feature is useful.

  • Package in its current form is very difficult to get started with (I'm trying to deploy one of these models to a raspberry pi in some form which avoids the need to install torch etc. ideally ONNX).

Describe what the feature would look like, if it is implemented.

  • Website documenting typical workflows and benchmarks on different machines for different models

I'd be keen to work on all of this.

Caveat - I had not found this notebook https://github.com/facebookresearch/d2go/blob/main/demo/d2go_beginner.ipynb which I believe resolves most of my frustrations.

There also seems to be some tooling provided for knowledge distillation but no docs on how to use it?

@GeorgePearse Thanks for the interest, there might be certain experimental features in the codebase but mainly for internal use, we'll update the doc if we decide to release them.

What's the status of distillation? If I could specify a torchscript path to an X101 from detecctron2 that would be great.