open-mmlab / open-mmlab/mmengine

[Docs] Top-level documentation of interdependent features

Open
#1,645 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.5k
Forks
464
PR merge metrics
No merged PRs in 30d

Description

📚 The doc issue

Due to the project specific documentation, there isn't information about interdependent parts. If I am using a CCN from MMCV, but everything else it in MMDet or MMEngine, I have a hard time telling if there were other ways of getting the model object type, especially because the class is just initializing PyTorch provided resources.
https://mmcv.readthedocs.io/en/2.x/_modules/mmcv/cnn/utils/fuse_conv_bn.html#fuse_conv_bn

Suggest a potential alternative/fix

It would be helpful to have an interface or relevant links for where those resources can be found in other packages. I think MMEngine should be the location for this connection as it has been made into the workhorse for the rest of the packages.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked MMCV fuse_conv_bn documentation and review how related resources are exposed across MMCV, MMDet, MMEngine, and PyTorch. Map the relevant interfaces or links between these packages; the documentation is done when users can find alternative ways to obtain the model object type and understand which package owns each resource.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, pytorch
Domain
documentation, machine-learning
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.