diff --git a/mindinsight/lineagemgr/__init__.py b/mindinsight/lineagemgr/__init__.py index 0809f353..235cc78b 100644 --- a/mindinsight/lineagemgr/__init__.py +++ b/mindinsight/lineagemgr/__init__.py @@ -12,3 +12,9 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +""" +Lineage manager. + +Lineagemgr provides model training information, including data processing information, +hyperparameters and model evaluation results, etc. +""" diff --git a/mindinsight/lineagemgr/common/__init__.py b/mindinsight/lineagemgr/common/__init__.py index 0809f353..e5995663 100644 --- a/mindinsight/lineagemgr/common/__init__.py +++ b/mindinsight/lineagemgr/common/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Common utils for lineagemgr.""" diff --git a/mindinsight/lineagemgr/common/exceptions/__init__.py b/mindinsight/lineagemgr/common/exceptions/__init__.py index 0809f353..1c872804 100644 --- a/mindinsight/lineagemgr/common/exceptions/__init__.py +++ b/mindinsight/lineagemgr/common/exceptions/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Exceptions and error code.""" diff --git a/mindinsight/lineagemgr/common/validator/__init__.py b/mindinsight/lineagemgr/common/validator/__init__.py index 0809f353..8901f7a2 100644 --- a/mindinsight/lineagemgr/common/validator/__init__.py +++ b/mindinsight/lineagemgr/common/validator/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Validator for lineagemgr.""" diff --git a/mindinsight/lineagemgr/querier/__init__.py b/mindinsight/lineagemgr/querier/__init__.py index e3077430..dabd63ea 100644 --- a/mindinsight/lineagemgr/querier/__init__.py +++ b/mindinsight/lineagemgr/querier/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Querier for lineagemgr.""" diff --git a/mindinsight/lineagemgr/summary/__init__.py b/mindinsight/lineagemgr/summary/__init__.py index e3077430..546829a4 100644 --- a/mindinsight/lineagemgr/summary/__init__.py +++ b/mindinsight/lineagemgr/summary/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Modules for lineage summary analyzer.""" diff --git a/mindinsight/optimizer/__init__.py b/mindinsight/optimizer/__init__.py index e3077430..6ccbf1a4 100644 --- a/mindinsight/optimizer/__init__.py +++ b/mindinsight/optimizer/__init__.py @@ -12,3 +12,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +""" +Optimizer. + +Optimizer provides optimization target distribution, parameter importance, etc. +""" diff --git a/mindinsight/optimizer/common/__init__.py b/mindinsight/optimizer/common/__init__.py new file mode 100644 index 00000000..940b42f9 --- /dev/null +++ b/mindinsight/optimizer/common/__init__.py @@ -0,0 +1,15 @@ +# Copyright 2020 Huawei Technologies Co., Ltd +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# ============================================================================ +"""Common modules for optimizer.""" diff --git a/mindinsight/optimizer/utils/__init__.py b/mindinsight/optimizer/utils/__init__.py index e3077430..04861cc7 100644 --- a/mindinsight/optimizer/utils/__init__.py +++ b/mindinsight/optimizer/utils/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Common utils for optimizer.""" diff --git a/tests/__init__.py b/tests/__init__.py index 0809f353..c19b0c67 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Test cases.""" diff --git a/tests/st/__init__.py b/tests/st/__init__.py index e3077430..fb884512 100644 --- a/tests/st/__init__.py +++ b/tests/st/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for mindinsight.""" diff --git a/tests/st/func/lineagemgr/__init__.py b/tests/st/func/lineagemgr/__init__.py index 0809f353..e247e0a0 100644 --- a/tests/st/func/lineagemgr/__init__.py +++ b/tests/st/func/lineagemgr/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for lineage.""" diff --git a/tests/st/func/lineagemgr/collection/__init__.py b/tests/st/func/lineagemgr/collection/__init__.py index 0809f353..5e23472b 100644 --- a/tests/st/func/lineagemgr/collection/__init__.py +++ b/tests/st/func/lineagemgr/collection/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for generating lineage summaries.""" diff --git a/tests/st/func/lineagemgr/collection/model/__init__.py b/tests/st/func/lineagemgr/collection/model/__init__.py index c5deecaa..0ccd364e 100644 --- a/tests/st/func/lineagemgr/collection/model/__init__.py +++ b/tests/st/func/lineagemgr/collection/model/__init__.py @@ -12,4 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ -"""Lineage collection.""" +"""ST for generating lineage summaries and mocked modules.""" diff --git a/tests/st/func/optimizer/__init__.py b/tests/st/func/optimizer/__init__.py index e3077430..67049415 100644 --- a/tests/st/func/optimizer/__init__.py +++ b/tests/st/func/optimizer/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for optimizer.""" diff --git a/tests/st/func/optimizer/targets/__init__.py b/tests/st/func/optimizer/targets/__init__.py index e3077430..a6daa9b8 100644 --- a/tests/st/func/optimizer/targets/__init__.py +++ b/tests/st/func/optimizer/targets/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for targets.""" diff --git a/tests/ut/lineagemgr/common/__init__.py b/tests/ut/lineagemgr/common/__init__.py index e3077430..1f8d3e64 100644 --- a/tests/ut/lineagemgr/common/__init__.py +++ b/tests/ut/lineagemgr/common/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Test cases for common utils.""" diff --git a/tests/ut/lineagemgr/common/validator/__init__.py b/tests/ut/lineagemgr/common/validator/__init__.py index e3077430..ff49fcde 100644 --- a/tests/ut/lineagemgr/common/validator/__init__.py +++ b/tests/ut/lineagemgr/common/validator/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Test cases for validator.""" diff --git a/tests/ut/lineagemgr/querier/__init__.py b/tests/ut/lineagemgr/querier/__init__.py index e3077430..03cecc6b 100644 --- a/tests/ut/lineagemgr/querier/__init__.py +++ b/tests/ut/lineagemgr/querier/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Test cases for querier.""" diff --git a/tests/ut/lineagemgr/summary/__init__.py b/tests/ut/lineagemgr/summary/__init__.py index e3077430..812f7432 100644 --- a/tests/ut/lineagemgr/summary/__init__.py +++ b/tests/ut/lineagemgr/summary/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Test cases for summary utils.""" diff --git a/tests/ut/optimizer/__init__.py b/tests/ut/optimizer/__init__.py index e3077430..986014ba 100644 --- a/tests/ut/optimizer/__init__.py +++ b/tests/ut/optimizer/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Test cases for optimizer.""" diff --git a/tests/utils/log_generators/__init__.py b/tests/utils/log_generators/__init__.py index 0809f353..285ffbee 100644 --- a/tests/utils/log_generators/__init__.py +++ b/tests/utils/log_generators/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Log generators and data to write.""" diff --git a/tests/utils/mindspore/application/__init__.py b/tests/utils/mindspore/application/__init__.py index 0809f353..c8b30ef0 100644 --- a/tests/utils/mindspore/application/__init__.py +++ b/tests/utils/mindspore/application/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Mocked mindspore.""" diff --git a/tests/utils/mindspore/application/model_zoo/__init__.py b/tests/utils/mindspore/application/model_zoo/__init__.py index 0809f353..14b7665b 100644 --- a/tests/utils/mindspore/application/model_zoo/__init__.py +++ b/tests/utils/mindspore/application/model_zoo/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Mocked model_zoo.""" diff --git a/tests/utils/mindspore/common/__init__.py b/tests/utils/mindspore/common/__init__.py index 0809f353..73f35394 100644 --- a/tests/utils/mindspore/common/__init__.py +++ b/tests/utils/mindspore/common/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Mocked common modules.""" diff --git a/tests/utils/mindspore/nn/loss/__init__.py b/tests/utils/mindspore/nn/loss/__init__.py index 0809f353..be9f36e3 100644 --- a/tests/utils/mindspore/nn/loss/__init__.py +++ b/tests/utils/mindspore/nn/loss/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Mocked loss."""