From 779ed45d74da0ee332d49aec0e9d59ed00667df1 Mon Sep 17 00:00:00 2001 From: Megvii Engine Team Date: Tue, 14 Apr 2020 10:50:03 +0800 Subject: [PATCH] docs(mge/parampack): refine parampack doc GitOrigin-RevId: 1cff83c3081c3d2dc1bbe2ed667367b66fa30385 --- python_module/megengine/module/parampack.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/python_module/megengine/module/parampack.py b/python_module/megengine/module/parampack.py index 01b2c5555..b6025022a 100644 --- a/python_module/megengine/module/parampack.py +++ b/python_module/megengine/module/parampack.py @@ -17,7 +17,10 @@ from .module import Module class ParamPack(Module): - r"""Pack module's parameters + r"""Pack module's parameters by gathering their memory to continuous address. + Using (device, dtype, requires_grad) as key, for example ('gpu0', float32, True), + parameters with same key will be packed togather. + It helps a lot for multimachine training by speeding up allreduce gradients. :param model: the module you want to pack parameters. :param nr_ignore_first: how many parameters will be unpacked at first. -- GitLab