diff --git a/design/meps/XXX-mep-template/README.md b/design/meps/XXX-mep-template/README.md index b22c0f8..cfda4cd 100644 --- a/design/meps/XXX-mep-template/README.md +++ b/design/meps/XXX-mep-template/README.md @@ -13,26 +13,34 @@ should be approved by the remaining approvers and/or the owning SIG. # MEP-XXX: Your short, descriptive title ## Table of Contents - -- [Summary](#summary) -- [Motivation](#motivation) - - [Goals](#goals) - - [Non-Goals](#non-goals) -- [Proposal](#proposal) - - [User Stories (optional)](#user-stories-optional) - - [Story 1](#story-1) - - [Story 2](#story-2) - - [Notes/Constraints/Caveats (optional)](#notesconstraintscaveats-optional) - - [Risks and Mitigations](#risks-and-mitigations) -- [Design Details](#design-details) - - [Graduation Criteria](#graduation-criteria) - - [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy) -- [Implementation History](#implementation-history) -- [Drawbacks](#drawbacks) -- [Alternatives](#alternatives) -- [Infrastructure Needed (optional)](#infrastructure-needed-optional) -- [References (optional)](#references-optional) - + + + +- [MEP-XXX: Your short, descriptive title](#mep-xxx-your-short-descriptive-title) + - [Table of Contents](#table-of-contents) + - [Summary](#summary) + - [Motivation](#motivation) + - [Goals](#goals) + - [Non-Goals](#non-goals) + - [Proposal](#proposal) + - [User Stories (optional)](#user-stories-optional) + - [Story 1](#story-1) + - [Story 2](#story-2) + - [Notes/Constraints/Caveats (optional)](#notesconstraintscaveats-optional) + - [Risks and Mitigations](#risks-and-mitigations) + - [Design Details](#design-details) + - [Test Plan](#test-plan) + - [Graduation Criteria](#graduation-criteria) + - [Alpha -> Beta Graduation](#alpha---beta-graduation) + - [Beta -> Stable Graduation](#beta---stable-graduation) + - [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy) + - [Implementation History](#implementation-history) + - [Drawbacks](#drawbacks) + - [Alternatives](#alternatives) + - [Infrastructure Needed (optional)](#infrastructure-needed-optional) + - [References (optional)](#references-optional) + + ## Summary @@ -134,6 +142,7 @@ proposal will be implemented, this is the place to discuss them. **Note:** *Not required until targeted at a release.* Consider the following in developing a test plan for this enhancement: + - Will there be e2e and integration tests, in addition to unit tests? - How will it be tested in isolation vs with other components? @@ -160,10 +169,11 @@ should keep this high-level with a focus on what signals will be looked at to determine graduation. Consider the following in developing the graduation criteria for this enhancement: + - Maturity levels (`alpha`, `beta`, `stable`) - Deprecation policy (TBD) -Clearly define what graduation means by either linking to the [API doc definition](https://www.mindspore.cn/api/en/master/index.html), or by redefining what graduation means. +Clearly define what graduation means by either linking to the [API doc definition](https://www.mindspore.cn/docs/api/en/master/index.html), or by redefining what graduation means. In general, we try to use the same stages (alpha, beta, stable), regardless how the functionality is accessed. @@ -196,6 +206,7 @@ this is in the test plan. Consider the following in developing an upgrade/downgrade strategy for this enhancement: + - What changes (in invocations, configurations, API use, etc.) is an existing cluster required to make on upgrade in order to keep previous behavior? - What changes (in invocations, configurations, API use, etc.) is an existing @@ -207,12 +218,14 @@ enhancement: ## Drawbacks diff --git a/design/meps/mep-serving/MEP-SERVING.md b/design/meps/mep-serving/MEP-SERVING.md index 432bc99..904c1d3 100644 --- a/design/meps/mep-serving/MEP-SERVING.md +++ b/design/meps/mep-serving/MEP-SERVING.md @@ -13,26 +13,34 @@ should be approved by the remaining approvers and/or the owning SIG. # MEP-SERVING: Serving ## Table of Contents - -- [Summary](#summary) -- [Motivation](#motivation) - - [Goals](#goals) - - [Non-Goals](#non-goals) -- [Proposal](#proposal) - - [User Stories (optional)](#user-stories-optional) - - [Story 1](#story-1) - - [Story 2](#story-2) - - [Notes/Constraints/Caveats (optional)](#notesconstraintscaveats-optional) - - [Risks and Mitigations](#risks-and-mitigations) -- [Design Details](#design-details) - - [Graduation Criteria](#graduation-criteria) - - [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy) -- [Implementation History](#implementation-history) -- [Drawbacks](#drawbacks) -- [Alternatives](#alternatives) -- [Infrastructure Needed (optional)](#infrastructure-needed-optional) -- [References (optional)](#references-optional) - + + + +- [MEP-SERVING: Serving](#mep-serving-serving) + - [Table of Contents](#table-of-contents) + - [Summary](#summary) + - [Motivation](#motivation) + - [Goals](#goals) + - [Non-Goals](#non-goals) + - [Proposal](#proposal) + - [User Stories (optional)](#user-stories-optional) + - [Story 1](#story-1) + - [Story 2](#story-2) + - [Notes/Constraints/Caveats (optional)](#notesconstraintscaveats-optional) + - [Risks and Mitigations](#risks-and-mitigations) + - [Design Details](#design-details) + - [Test Plan](#test-plan) + - [Graduation Criteria](#graduation-criteria) + - [Alpha -> Beta Graduation](#alpha---beta-graduation) + - [Beta -> Stable Graduation](#beta---stable-graduation) + - [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy) + - [Implementation History](#implementation-history) + - [Drawbacks](#drawbacks) + - [Alternatives](#alternatives) + - [Infrastructure Needed (optional)](#infrastructure-needed-optional) + - [References (optional)](#references-optional) + + ## Summary @@ -57,7 +65,6 @@ updates. MindSpore Serving is a lightweight and high-performance service module that helps MindSpore developers efficiently deploy online inference services in the production environment. After completing model training using MindSpore, you can export the MindSpore model and use MindSpore Serving to create an inference service for the model. Currently, only Ascend 910 is supported. - ## Motivation 1. RESTful -``` -POST http://${HOST_IP}:${PORT_NUM}/model/${MODEL_NAME}[/version/${VERSION}]:${METHOD_NAME} -``` + + ```bash + POST http://${HOST_IP}:${PORT_NUM}/model/${MODEL_NAME}[/version/${VERSION}]:${METHOD_NAME} + ``` 2. instances format -``` -{ - "instances":[ - { - "tagx": "foo", - "signalx": [1,2,3,4,5], - "sensorx": [[1,2], [3,4]] - }, - { - "tagx": {"b64": "bytes_data_base64_code"}, - "signalx": 3, - "sensorx": [[4,5], [6,8], [4,5], [6,8]] - } - ] -} -``` + + ```json + { + "instances":[ + { + "tagx": "foo", + "signalx": [1,2,3,4,5], + "sensorx": [[1,2], [3,4]] + }, + { + "tagx": {"b64": "bytes_data_base64_code"}, + "signalx": 3, + "sensorx": [[4,5], [6,8], [4,5], [6,8]] + } + ] + } + ``` 3. replay -``` -{ - "instances":[ - { - "label": "new" - }, - { - "tagx": {"b64": "bytes_data_base64_code"}, - "signalx": 3, - "sensorx": [[4,5], [6,8], [4,5], [6,8]] - } - ] -} -``` + + ```json + { + "instances":[ + { + "label": "new" + }, + { + "tagx": {"b64": "bytes_data_base64_code"}, + "signalx": 3, + "sensorx": [[4,5], [6,8], [4,5], [6,8]] + } + ] + } + ``` ### Test Plan @@ -200,6 +212,7 @@ POST http://${HOST_IP}:${PORT_NUM}/model/${MODEL_NAME}[/version/${VERSION}]:${ME **Note:** *Not required until targeted at a release.* Consider the following in developing a test plan for this enhancement: + - Will there be e2e and integration tests, in addition to unit tests? - How will it be tested in isolation vs with other components? @@ -218,7 +231,6 @@ when drafting this test plan. 2.st - ### Graduation Criteria NA diff --git a/security/coding_guild_python_zh_cn.md b/security/coding_guild_python_zh_cn.md index 564d03d..ab61c6a 100644 --- a/security/coding_guild_python_zh_cn.md +++ b/security/coding_guild_python_zh_cn.md @@ -101,7 +101,7 @@ import xxx **规则 1.3.2 对外的类、方法、算子、Cell注释格式。** - `class` 和 `def` 的注释格式相同，采用业界通用的python注释语法，写在声明下方并缩进，所有的 `class` 和 `def` 都需要写注释，模块内部的类和方法可以只写一条简介。 -- 注释格式详见[MindSpore注释规范](https://gitee.com/mindspore/community/blob/master/security/comments_specification.md)。 +- 注释格式详见[MindSpore注释规范](https://gitee.com/mindspore/community/blob/master/security/comments_specification_zh_cn.md)。 **规则 1.3.3 不允许通过注释屏蔽pylint告警。** diff --git a/sigs/data/README.md b/sigs/data/README.md index 8965609..6d54b16 100644 --- a/sigs/data/README.md +++ b/sigs/data/README.md @@ -20,11 +20,11 @@ This is the working repo for the Data special interest group (SIG). This repo co * Slack channel: * Documents and artifacts: -## Representative vedios +## Representative videos * [mindspore data processing introduction](https://www.bilibili.com/video/BV1RZ4y1W7FL) -* [mindspore data loading and data format conversion](https://www.mindspore.cn/tutorial/training/zh-CN/master/quick_start/quick_video/loading_the_dataset_and_converting_data_format.html) -* [optimize data processing](https://www.mindspore.cn/tutorial/training/zh-CN/master/quick_start/quick_video/optimize_data_processing.html) +* [mindspore data loading and data format conversion](https://www.mindspore.cn/docs/programming_guide/zh-CN/master/quick_start/quick_video/loading_the_dataset_and_converting_data_format.html) +* [optimize data processing](https://www.mindspore.cn/docs/programming_guide/zh-CN/master/quick_start/quick_video/optimize_data_processing.html) ## Main issue To be solved diff --git a/sigs/data/docs/official_resource.md b/sigs/data/docs/official_resource.md index 28864a3..d4920b6 100644 --- a/sigs/data/docs/official_resource.md +++ b/sigs/data/docs/official_resource.md @@ -1,5 +1,5 @@ ## Resource about Dataset in mindspore.cn -* [data loading and processing](https://www.mindspore.cn/tutorial/zh-CN/master/dataset.html) -* [data pipeline](https://www.mindspore.cn/doc/programming_guide/zh-CN/master/data_pipeline.html) -* [dataset API introduction](https://www.mindspore.cn/doc/api_python/zh-CN/master/mindspore/mindspore.dataset.html) +* [data loading and processing](https://www.mindspore.cn/tutorials/zh-CN/master/index.html) +* [dataset sample](https://www.mindspore.cn/docs/programming_guide/zh-CN/master/dataset_sample.html) +* [dataset API introduction](https://www.mindspore.cn/docs/api/zh-CN/master/api_python/mindspore.dataset.html)