diff --git a/mindinsight/common/hook/__init__.py b/mindinsight/common/hook/__init__.py index 47b43a6e..03b9791e 100644 --- a/mindinsight/common/hook/__init__.py +++ b/mindinsight/common/hook/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Hook module used to define relative hook.""" diff --git a/mindinsight/datavisual/data_access/__init__.py b/mindinsight/datavisual/data_access/__init__.py index 0809f353..78ece42d 100644 --- a/mindinsight/datavisual/data_access/__init__.py +++ b/mindinsight/datavisual/data_access/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Data access module used to define file operation.""" diff --git a/mindinsight/datavisual/data_transform/__init__.py b/mindinsight/datavisual/data_transform/__init__.py index 0809f353..3788b8d3 100644 --- a/mindinsight/datavisual/data_transform/__init__.py +++ b/mindinsight/datavisual/data_transform/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Data transform module used to load data and define relative container and so on.""" diff --git a/mindinsight/datavisual/processors/__init__.py b/mindinsight/datavisual/processors/__init__.py index 0809f353..926612b0 100644 --- a/mindinsight/datavisual/processors/__init__.py +++ b/mindinsight/datavisual/processors/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Processors module used to define all kinds of processor.""" diff --git a/mindinsight/datavisual/proto_files/__init__.py b/mindinsight/datavisual/proto_files/__init__.py index 0809f353..cf51fb6f 100644 --- a/mindinsight/datavisual/proto_files/__init__.py +++ b/mindinsight/datavisual/proto_files/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Proto files module used to define proto and created pb2 file by protoc according to these proto files.""" diff --git a/mindinsight/debugger/common/exceptions/__init__.py b/mindinsight/debugger/common/exceptions/__init__.py index e3077430..123deffc 100644 --- a/mindinsight/debugger/common/exceptions/__init__.py +++ b/mindinsight/debugger/common/exceptions/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Common exceptions for debugger.""" diff --git a/mindinsight/debugger/stream_cache/__init__.py b/mindinsight/debugger/stream_cache/__init__.py index e3077430..ae29db32 100644 --- a/mindinsight/debugger/stream_cache/__init__.py +++ b/mindinsight/debugger/stream_cache/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Debugger stream cache module.""" diff --git a/mindinsight/mindconverter/__init__.py b/mindinsight/mindconverter/__init__.py index e3077430..7bd90e4c 100644 --- a/mindinsight/mindconverter/__init__.py +++ b/mindinsight/mindconverter/__init__.py @@ -12,3 +12,9 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +""" +MindConverter. + +MindConverter is a migration tool to transform the model scripts from PyTorch to Mindspore. +Users can migrate their PyTorch models to Mindspore rapidly with minor changes according to the conversion report. +""" diff --git a/mindinsight/mindconverter/common/__init__.py b/mindinsight/mindconverter/common/__init__.py index e3077430..c1dd9d77 100644 --- a/mindinsight/mindconverter/common/__init__.py +++ b/mindinsight/mindconverter/common/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Common function for mindconverter.""" diff --git a/mindinsight/profiler/common/__init__.py b/mindinsight/profiler/common/__init__.py index e3077430..9efaa145 100644 --- a/mindinsight/profiler/common/__init__.py +++ b/mindinsight/profiler/common/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Common function for profiler.""" diff --git a/mindinsight/profiler/common/exceptions/__init__.py b/mindinsight/profiler/common/exceptions/__init__.py index e3077430..3dfbbbb9 100644 --- a/mindinsight/profiler/common/exceptions/__init__.py +++ b/mindinsight/profiler/common/exceptions/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Exceptions for profiler.""" diff --git a/mindinsight/profiler/common/validator/__init__.py b/mindinsight/profiler/common/validator/__init__.py index e3077430..54a40646 100644 --- a/mindinsight/profiler/common/validator/__init__.py +++ b/mindinsight/profiler/common/validator/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Validator for profiler.""" diff --git a/mindinsight/profiler/proposer/__init__.py b/mindinsight/profiler/proposer/__init__.py index 0809f353..04dd4d24 100644 --- a/mindinsight/profiler/proposer/__init__.py +++ b/mindinsight/profiler/proposer/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Proposer for profiler.""" diff --git a/mindinsight/scripts/__init__.py b/mindinsight/scripts/__init__.py index 0809f353..9f3f58e0 100644 --- a/mindinsight/scripts/__init__.py +++ b/mindinsight/scripts/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Scripts module used to define start and stop command for mindinsight.""" diff --git a/mindinsight/utils/__init__.py b/mindinsight/utils/__init__.py index 8b70b66f..2c826c67 100644 --- a/mindinsight/utils/__init__.py +++ b/mindinsight/utils/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Utils module for mindinsight.""" diff --git a/mindinsight/wizard/__init__.py b/mindinsight/wizard/__init__.py index e3077430..f2de174e 100644 --- a/mindinsight/wizard/__init__.py +++ b/mindinsight/wizard/__init__.py @@ -12,3 +12,11 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +""" +MindWizard. + +MindWizard is a tool for quickly generating classic network scripts. +It collects user preference on the combination of network parameters, +such models, hyperparameters and datasets, then automatically generates target network scripts. +The generated scripts can be used for training and evaluation in the Ascend or GPU environment. +""" diff --git a/mindinsight/wizard/base/__init__.py b/mindinsight/wizard/base/__init__.py index e3077430..edc846e2 100644 --- a/mindinsight/wizard/base/__init__.py +++ b/mindinsight/wizard/base/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Base entry definition for wizard.""" diff --git a/mindinsight/wizard/common/__init__.py b/mindinsight/wizard/common/__init__.py index e3077430..760f5e02 100644 --- a/mindinsight/wizard/common/__init__.py +++ b/mindinsight/wizard/common/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Common function for wizard.""" diff --git a/mindinsight/wizard/conf/__init__.py b/mindinsight/wizard/conf/__init__.py index e3077430..be92de83 100644 --- a/mindinsight/wizard/conf/__init__.py +++ b/mindinsight/wizard/conf/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Configuration for wizard.""" diff --git a/mindinsight/wizard/dataset/__init__.py b/mindinsight/wizard/dataset/__init__.py index e3077430..b755a4e0 100644 --- a/mindinsight/wizard/dataset/__init__.py +++ b/mindinsight/wizard/dataset/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Dataset for wizard.""" diff --git a/mindinsight/wizard/network/__init__.py b/mindinsight/wizard/network/__init__.py index e3077430..65c31928 100644 --- a/mindinsight/wizard/network/__init__.py +++ b/mindinsight/wizard/network/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""Network definition for wizard.""" diff --git a/tests/st/func/__init__.py b/tests/st/func/__init__.py index e3077430..1ad28ea5 100644 --- a/tests/st/func/__init__.py +++ b/tests/st/func/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for func.""" diff --git a/tests/st/func/datavisual/__init__.py b/tests/st/func/datavisual/__init__.py index e3077430..90313e51 100644 --- a/tests/st/func/datavisual/__init__.py +++ b/tests/st/func/datavisual/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for datavisual.""" diff --git a/tests/st/func/datavisual/graph/__init__.py b/tests/st/func/datavisual/graph/__init__.py index e3077430..9f3e9476 100644 --- a/tests/st/func/datavisual/graph/__init__.py +++ b/tests/st/func/datavisual/graph/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for graph.""" diff --git a/tests/st/func/datavisual/histogram/__init__.py b/tests/st/func/datavisual/histogram/__init__.py index e3077430..8790f36d 100644 --- a/tests/st/func/datavisual/histogram/__init__.py +++ b/tests/st/func/datavisual/histogram/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for histogram.""" diff --git a/tests/st/func/datavisual/image/__init__.py b/tests/st/func/datavisual/image/__init__.py index e3077430..8919d117 100644 --- a/tests/st/func/datavisual/image/__init__.py +++ b/tests/st/func/datavisual/image/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for image.""" diff --git a/tests/st/func/datavisual/scalar/__init__.py b/tests/st/func/datavisual/scalar/__init__.py index e3077430..7a247243 100644 --- a/tests/st/func/datavisual/scalar/__init__.py +++ b/tests/st/func/datavisual/scalar/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for scalar.""" diff --git a/tests/st/func/datavisual/taskmanager/__init__.py b/tests/st/func/datavisual/taskmanager/__init__.py index e3077430..48a4db85 100644 --- a/tests/st/func/datavisual/taskmanager/__init__.py +++ b/tests/st/func/datavisual/taskmanager/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for taskmanager.""" diff --git a/tests/st/func/datavisual/tensor/__init__.py b/tests/st/func/datavisual/tensor/__init__.py index e3077430..1a827b78 100644 --- a/tests/st/func/datavisual/tensor/__init__.py +++ b/tests/st/func/datavisual/tensor/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for tensor.""" diff --git a/tests/st/func/datavisual/workflow/__init__.py b/tests/st/func/datavisual/workflow/__init__.py index e3077430..b25ebbfc 100644 --- a/tests/st/func/datavisual/workflow/__init__.py +++ b/tests/st/func/datavisual/workflow/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for workflow.""" diff --git a/tests/st/func/mindconverter/__init__.py b/tests/st/func/mindconverter/__init__.py index e3077430..7e02b335 100644 --- a/tests/st/func/mindconverter/__init__.py +++ b/tests/st/func/mindconverter/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""ST for mindconverter.""" diff --git a/tests/ut/backend/__init__.py b/tests/ut/backend/__init__.py index e3077430..b8ca91f7 100644 --- a/tests/ut/backend/__init__.py +++ b/tests/ut/backend/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""UT for backend.""" diff --git a/tests/ut/backend/datavisual/__init__.py b/tests/ut/backend/datavisual/__init__.py index 0809f353..482f9d93 100644 --- a/tests/ut/backend/datavisual/__init__.py +++ b/tests/ut/backend/datavisual/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""UT for backend.datavisual.""" diff --git a/tests/ut/backend/lineagemgr/__init__.py b/tests/ut/backend/lineagemgr/__init__.py index e3077430..c165bb60 100644 --- a/tests/ut/backend/lineagemgr/__init__.py +++ b/tests/ut/backend/lineagemgr/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""UT for backend.linegemgr.""" diff --git a/tests/ut/datavisual/__init__.py b/tests/ut/datavisual/__init__.py index 0809f353..dda8e74a 100644 --- a/tests/ut/datavisual/__init__.py +++ b/tests/ut/datavisual/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""UT for datavisual.""" diff --git a/tests/ut/datavisual/data_transform/__init__.py b/tests/ut/datavisual/data_transform/__init__.py index 0809f353..3b0edf80 100644 --- a/tests/ut/datavisual/data_transform/__init__.py +++ b/tests/ut/datavisual/data_transform/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""UT for data transform.""" diff --git a/tests/ut/datavisual/data_transform/loader_generators/__init__.py b/tests/ut/datavisual/data_transform/loader_generators/__init__.py index e69de29b..6fcca48f 100644 --- a/tests/ut/datavisual/data_transform/loader_generators/__init__.py +++ b/tests/ut/datavisual/data_transform/loader_generators/__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. +# ============================================================================ +"""UT for loader generators.""" diff --git a/tests/ut/datavisual/processors/__init__.py b/tests/ut/datavisual/processors/__init__.py index 0809f353..ab7c3d7c 100644 --- a/tests/ut/datavisual/processors/__init__.py +++ b/tests/ut/datavisual/processors/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""UT for processors.""" diff --git a/tests/ut/mindconverter/__init__.py b/tests/ut/mindconverter/__init__.py index e3077430..4181644e 100644 --- a/tests/ut/mindconverter/__init__.py +++ b/tests/ut/mindconverter/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""UT for mindconverter.""" diff --git a/tests/ut/profiler/analyser/__init__.py b/tests/ut/profiler/analyser/__init__.py index e3077430..b0679f06 100644 --- a/tests/ut/profiler/analyser/__init__.py +++ b/tests/ut/profiler/analyser/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""UT for profiler.analyser.""" diff --git a/tests/ut/profiler/common/__init__.py b/tests/ut/profiler/common/__init__.py index e3077430..8c6eb651 100644 --- a/tests/ut/profiler/common/__init__.py +++ b/tests/ut/profiler/common/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""UT for profiler.common.""" diff --git a/tests/ut/profiler/common/validator/__init__.py b/tests/ut/profiler/common/validator/__init__.py index e3077430..8428c994 100644 --- a/tests/ut/profiler/common/validator/__init__.py +++ b/tests/ut/profiler/common/validator/__init__.py @@ -12,3 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # ============================================================================ +"""UT for profiler.validator."""