[Docs] Fix API files of en docs (#525)

* [Docs] Fix api files of en docs * minor fix

[Docs] Fix API files of en docs (#525)
* [Docs] Fix api files of en docs * minor fix
114fa215 · Zaida Zhou · GitHub · c1178fad · 114fa215 · 114fa215
Unverified Commit 114fa215 authored 2 years ago by Zaida Zhou Committed by GitHub 2 years ago
--- a/docs/en/api/dataset.rst
+++ b/docs/en/api/dataset.rst
@@ -21,7 +21,6 @@ Dataset

   BaseDataset
   Compose
-   force_full_init

 Dataset Wrapper
 ----------------
@@ -52,7 +51,6 @@ Utils
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   default_collate
   pseudo_collate

--- a/docs/en/api/device.rst
+++ b/docs/en/api/device.rst
@@ -9,7 +9,6 @@ mmengine.device
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   get_device
   get_max_cuda_memory

--- a/docs/en/api/dist.rst
+++ b/docs/en/api/dist.rst
@@ -17,7 +17,6 @@ dist
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   gather
   gather_object
@@ -39,7 +38,6 @@ utils
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   get_dist_info
   init_dist

--- a/docs/en/api/evaluator.rst
+++ b/docs/en/api/evaluator.rst
@@ -39,6 +39,5 @@ Utils
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   get_metric_value
--- a/docs/en/api/fileio.rst
+++ b/docs/en/api/fileio.rst
@@ -46,7 +46,6 @@ File IO
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   dump
   load
@@ -58,7 +57,6 @@ Parse File
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   dict_from_file
   list_from_file
--- a/docs/en/api/hub.rst
+++ b/docs/en/api/hub.rst
@@ -9,7 +9,6 @@ mmengine.hub
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   get_config
-   get_config
+   get_model
--- a/docs/en/api/logging.rst
+++ b/docs/en/api/logging.rst
@@ -14,4 +14,9 @@ mmengine.logging
   MMLogger
   MessageHub
   HistoryBuffer
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+
   print_log
--- a/docs/en/api/model.rst
+++ b/docs/en/api/model.rst
@@ -60,6 +60,12 @@ Model Wrapper
   MMDistributedDataParallel
   MMSeparateDistributedDataParallel
   MMFullyShardedDataParallel
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: classtemplate.rst
+
   is_model_wrapper

 Weight Initialization
@@ -79,6 +85,11 @@ Weight Initialization
   TruncNormalInit
   UniformInit
   XavierInit
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+
   bias_init_with_prob
   caffe2_xavier_init
   constant_init
@@ -96,7 +107,6 @@ Utils
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   detect_anomalous_params
   merge_dict

--- a/docs/en/api/optim.rst
+++ b/docs/en/api/optim.rst
@@ -23,6 +23,11 @@ Optimizer
    OptimWrapper
    OptimWrapperDict
    DefaultOptimWrapperConstructor
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+
    build_optim_wrapper

 Scheduler

--- a/docs/en/api/registry.rst
+++ b/docs/en/api/registry.rst
@@ -13,6 +13,11 @@ mmengine.registry

   Registry
   DefaultScope
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+
   build_from_cfg
   build_model_from_cfg
   build_runner_from_cfg

--- a/docs/en/api/runner.rst
+++ b/docs/en/api/runner.rst
@@ -44,6 +44,11 @@ Checkpoints
   :template: classtemplate.rst

   CheckpointLoader
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+
   find_latest_checkpoint
   get_deprecated_model_names
   get_external_models
@@ -61,7 +66,6 @@ AMP
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   autocast

@@ -75,4 +79,9 @@ Miscellaneous

   LogProcessor
   Priority
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+
   get_priority
--- a/docs/en/api/utils.dl_utils.rst
+++ b/docs/en/api/utils.dl_utils.rst
@@ -11,6 +11,12 @@ mmengine.utils.dl_utils
   :nosignatures:
   :template: classtemplate.rst

+   TimeCounter
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+
   collect_env
   load_url
   has_batch_norm
@@ -19,6 +25,5 @@ mmengine.utils.dl_utils
   tensor2imgs
   TORCH_VERSION
   set_multi_processing
-   TimeCounter
   torch_meshgrid
   is_jit_tracing
--- a/docs/en/api/utils.rst
+++ b/docs/en/api/utils.rst
@@ -28,7 +28,6 @@ Path
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   check_file_exist
   fopen
@@ -44,7 +43,6 @@ Package
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   call_command
   install_package
@@ -57,7 +55,6 @@ Version
 .. autosummary::
   :toctree: generated
   :nosignatures:
-   :template: classtemplate.rst

   digit_version
   get_git_hash
@@ -71,6 +68,11 @@ Progress Bar
   :template: classtemplate.rst

   ProgressBar
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+
   track_iter_progress
   track_parallel_progress
   track_progress
@@ -84,6 +86,13 @@ Miscellaneous
   :nosignatures:
   :template: classtemplate.rst

+   Timer
+   TimerError
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+
   is_list_of
   is_tuple_of
   is_seq_of
@@ -105,6 +114,4 @@ Miscellaneous
   import_modules_from_strings
   requires_executable
   requires_package
-   Timer
-   TimerError
   check_time
--- a/docs/zh_cn/api/hub.rst
+++ b/docs/zh_cn/api/hub.rst
@@ -11,4 +11,4 @@ mmengine.hub
   :nosignatures:

   get_config
-   get_config
+   get_model