Skip to content

Commit

Permalink
docs: revised updates for v1.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
rrxie committed Aug 11, 2023
1 parent bc4b939 commit 8081215
Show file tree
Hide file tree
Showing 25 changed files with 40 additions and 39 deletions.
2 changes: 1 addition & 1 deletion docs/en-branded/cost.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
You will be responsible for the cost of using each of the Amazon services when running the solution. As of December 2022, the main factors affecting the solution cost include:
You will be responsible for the cost of using each of the Amazon services when running the solution. As of this revision, the main factors affecting the solution cost include:

- Amazon API Gateway calls
- Amazon API Gateway data output
Expand Down
2 changes: 1 addition & 1 deletion docs/en-branded/deploy-image-super-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ feature_scenario: Applicable to converting original image assets into high resol

## Cost Estimation

You are responsible for the cost of using each Amazon Web Services service when running the solution. As of June 2022, the main cost factors affecting the solution include.
You are responsible for the cost of using each Amazon Web Services service when running the solution. As of this revision, the main cost factors affecting the solution include.

- Amazon API Gateway calls
- Amazon API Gateway data output
Expand Down
2 changes: 1 addition & 1 deletion docs/en-branded/deploy-text-similarity.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ With text pair as input, it returns the cosine similarity of two texts. This is

## Cost Estimation

You are responsible for the cost of using each Amazon Web Services service when running the solution. As of June 2022, the main cost factors affecting the solution include.
You are responsible for the cost of using each Amazon Web Services service when running the solution. As of this revision, the main cost factors affecting the solution include.

- Amazon Lambda invocations
- Amazon Lambda running time
Expand Down
2 changes: 1 addition & 1 deletion docs/en-branded/include-deploy-cost-10GB.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Cost estimation

You are responsible for the cost of using each Amazon Web Services service when running the solution. As of June 2022, the main cost factors affecting the solution include.
You are responsible for the cost of using each Amazon Web Services service when running the solution. As of this revision, the main cost factors affecting the solution include.

- Amazon API Gateway calls
- Amazon API Gateway data output
Expand Down
2 changes: 1 addition & 1 deletion docs/en-branded/include-deploy-cost-8GB.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Cost estimation

You are responsible for the cost of using each Amazon Web Services service when running the solution. As of June 2022, the main cost factors affecting the solution include.
You are responsible for the cost of using each Amazon Web Services service when running the solution. As of this revision, the main cost factors affecting the solution include.

- Amazon API Gateway calls
- Amazon API Gateway data output
Expand Down
7 changes: 4 additions & 3 deletions docs/en/cost.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
You will be responsible for the cost of using each of the AWS services when running the solution. As of December 2022, the main factors affecting the solution cost include:
You will be responsible for the cost of using each of the AWS services when running the solution. As of this revision, the main factors affecting the solution cost include:

- Amazon API Gateway calls
- Amazon API Gateway data output
Expand All @@ -22,8 +22,9 @@ You can refer to the Cost Estimation section corresponding to each API to check

| **API** | **Cost Estimation** |
|--------------|--------------|
|General OCR (Simplified Chinese)|[View](deploy-general-ocr.md#_3)|
|General OCR (Traditional Chinese)|[View](deploy-general-ocr-traditional.md#_3)|
|Lite OCR (Simplified Chinese)|[View](deploy-general-ocr.md#_3)|
|Lite OCR (Traditional Chinese)|[View](deploy-general-ocr-traditional.md#_3)|
|Advanced OCR (Multilingual)|[View](deploy-advanced-ocr.md#_3)|
|Custom OCR|[View](deploy-custom-ocr.md#_3)|
|Car License Plate|[View](deploy-car-license-plate.md#_3)|
|Face Detection|[View](deploy-face-detection.md#_3)|
Expand Down
2 changes: 1 addition & 1 deletion docs/en/deploy-advanced-ocr.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ feature_endpoint: advanced_ocr
deployment_time: 20 Minutes
destroy_time: 10 Minutes
sample_image: Image URL address
feature_description: Advanced OCR for Multi-languages(Simplified Chinese, Vietnamese, Korean, Japanese) and numbers, alphabetical characters, symbols. Return the information such as text or coordinates.
feature_description: Advanced OCR for multiple languages (Simplified Chinese, Vietnamese, Korean, Japanese) and numbers, alphabetical characters, symbols. Return the information such as text or coordinates.
feature_scenario: Applicable to a variety of scenarios such as paper documents changed to electronic format, document identification, and content review to improve information processing efficiency.
---

Expand Down
22 changes: 11 additions & 11 deletions docs/en/deploy-general-nlu.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ include "include-deploy-description.md"
%}

!!! Info "Note"
In v1.4.0, General NLU API only support Chinese language processing.
In version 1.4.0, General NLU API only supports Chinese language processing.

## API reference

Expand All @@ -26,10 +26,10 @@ include "include-deploy-description.md"

| **Name** | **Type** | **Required** | **Description** |
|--------------|----------|--------------|----------------------------------------------------------------|
| subtask_type | *String* | Yes | Fixed as "Text Classification" |
| text | *String* | Yes | The text to be classified |
| choices | *List* | Yes | Candidate labels, please refer to the **Request Body Example** |
| question | *String* | Yes | Prompts the model for guidance |
| subtask_type | *String* | Yes | Has the fixed value of "Text Classification". |
| text | *String* | Yes | Indicates the text to be classified. |
| choices | *List* | Yes | Indicates the candidate labels. For more information, please refer to the **Request Body Example**. |
| question | *String* | Yes | Used to prompt the model for guidance. |

- Example Request

Expand Down Expand Up @@ -105,7 +105,7 @@ include "include-deploy-description.md"

**Example 1 Response**

Assuming the model returns the category of the "unclassified text" as "sports."
Assume the model returns the category of the "unclassified text" as "sports."

``` json
{
Expand Down Expand Up @@ -180,7 +180,7 @@ Assuming the model returns the category of the "unclassified text" as "sports."
| subtask_type | *String* | Yes | Fixed as "Sentiment Classification" |
| text | *String* | Yes | The text to be classified |
| choices | *List* | Yes | Candidate sentiment labels, please refer to the **Request Body Example** |
| question | *String* | Yes | Prompts the model for guidance |
| question | *String* | Yes | Used to prompt the model for guidance |

- Example Request

Expand Down Expand Up @@ -214,7 +214,7 @@ Assuming the model returns the category of the "unclassified text" as "sports."

- Example JSON response

Assuming the model returns the sentiment polarity of the "unclassified user comment" as "neutral."
Assume the model returns the sentiment polarity of the "unclassified user comment" as "neutral."

``` json
{
Expand Down Expand Up @@ -246,8 +246,8 @@ Assuming the model returns the sentiment polarity of the "unclassified user comm

| **Name** | **Type** | **Required** | **Description** |
|--------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| subtask_type | *String* | Yes | Fixed as "Text Matching" |
| text | *String* | Yes | The first text |
| subtask_type | *String* | Yes | Has the fixed value of "Text Matching" |
| text | *String* | Yes | Indicates the first text |
| choices | *List* | Yes | The entity_type of each element is the concatenation of the prompt word with the second text, for example, "can be inferred: second text" or "can be understood as: second text". Please refer to the **Request Body Example** for details. |
| question | *String* | Yes | Prompts the model for guidance |

Expand Down Expand Up @@ -392,7 +392,7 @@ Assuming the model returns the sentiment polarity of the "unclassified user comm

- Example JSON response

Assuming the model returns the sentiment polarity of the "unclassified user comment" as "neutral."
Assume the model returns the sentiment polarity of the "unclassified user comment" as "neutral."

``` json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/en/deploy-image-super-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ feature_scenario: Applicable to converting original image assets into high resol

## Cost Estimation

You are responsible for the cost of using each Amazon Web Services service when running the solution. As of June 2022, the main cost factors affecting the solution include.
You are responsible for the cost of using each Amazon Web Services service when running the solution. As of this revision, the main cost factors affecting the solution include.

- Amazon API Gateway calls
- Amazon API Gateway data output
Expand Down
2 changes: 1 addition & 1 deletion docs/en/deploy-text-similarity.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ With text pair as input, it returns the cosine similarity of two texts. This is

## Cost Estimation

You are responsible for the cost of using each Amazon Web Services service when running the solution. As of June 2022, the main cost factors affecting the solution include.
You are responsible for the cost of using each Amazon Web Services service when running the solution. As of this revision, the main cost factors affecting the solution include.

- AWS Lambda invocations
- AWS Lambda running time
Expand Down
4 changes: 2 additions & 2 deletions docs/en/include-deploy-cost-10GB.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Cost estimation

You are responsible for the cost of using each Amazon Web Services service when running the solution. As of June 2022, the main cost factors affecting the solution include.
You are responsible for the cost of using each Amazon Web Services service when running the solution. As of this revision, the main cost factors affecting the solution include.

- Amazon API Gateway calls
- Amazon API Gateway data output
Expand All @@ -20,7 +20,7 @@ If you choose an Amazon SageMaker based deployment, the factors also include:

### Cost estimation example 1

In AWS China (Ningxia) Region operated by NWCD (cn-northwest-1), process an image of 1MB in 1 seconds
In AWS China (Ningxia) Region operated by NWCD (cn-northwest-1), process an image of 1MB in 1 second

The cost of using this solution to process the image is shown below:

Expand Down
4 changes: 2 additions & 2 deletions docs/en/include-deploy-cost-8GB.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Cost estimation

You are responsible for the cost of using each Amazon Web Services service when running the solution. As of June 2022, the main cost factors affecting the solution include.
You are responsible for the cost of using each Amazon Web Services service when running the solution. As of this revision, the main cost factors affecting the solution include.

- Amazon API Gateway calls
- Amazon API Gateway data output
Expand All @@ -20,7 +20,7 @@ If you choose an Amazon SageMaker based deployment, the factors also include:

### Cost estimation example 1

In AWS China (Ningxia) Region operated by NWCD (cn-northwest-1), process an image of 1MB in 1 seconds
In AWS China (Ningxia) Region operated by NWCD (cn-northwest-1), process an image of 1MB in 1 second

The cost of using this solution to process the image is shown below:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/revisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
| September 2021 | **Release 1.0.0** <br> Support the following AI features: <ol><li>General OCR</li><li>Image Super Resolution</li><li>Pornography Detection</li><li>Human Image Segmentation</li></ol> |
| June 2022 | **Release 1.2.0** <br>Updated the following AI features: <ol><li>Optimized General OCR</li><li>General OCR (Traditional Chinese)</li><li>Custom OCR</li><li>Image Similarity</li><li>Object Recognition</li><li>Face Detection</li><li>Face Comparison</li><li>Human Attribute Recognition</li><li>Car License Plate</li><li>Text Similarity</li></ol> Updated the solution architecture: <ol><li>Support OpenAPI specification and integrate API Explorer</li><li>AI model containerization</li><li>Upgrade CDK to 2.27.0</li><li>Support CloudFormation deployment</li></ol> |
| December 2022 | **Release 1.3.0** <br>AI features update: <ol><li>All features support Amazon SageMaker architecture</li></ol> Updated the solution architecture: <ol><li>Support deployment of Amazon SageMaker-based architecture</li></ol> |
| Auguest 2023 | **Release 1.4.0** <br>AI features update: <ol> <li>Add multilingual advanced optical character recognition (OCR) model.</li> <li>Add General natural language understanding model.</li> <li>Modify general text recognition to lightweight text recognition.</li> </ol> |
| Auguest 2023 | **Release 1.4.0** <br>AI features update: <ol> <li>Add multilingual advanced optical character recognition (OCR) model.</li> <li>Add general natural language understanding model.</li> <li>Modify general text recognition to lightweight text recognition.</li> </ol> |
2 changes: 1 addition & 1 deletion docs/zh-branded/cost.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 成本预估

您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至2022年12月,影响解决方案的成本因素主要包括:
您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至这次发布的版本,影响解决方案的成本因素主要包括:

- Amazon API Gateway调用次数
- Amazon API Gateway数据输出量
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-branded/deploy-image-super-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ feature_scenario: 可应用于等多种场景,解决原始图片分辨率不

## 成本预估

您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至2022年6月,影响解决方案的成本因素主要包括:
您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至这次发布的版本,影响解决方案的成本因素主要包括:

- Amazon API Gateway调用次数
- Amazon API Gateway数据输出量
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-branded/deploy-text-similarity.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ feature_scenario: 可应用于搜索引擎、推荐系统、机器翻译、自

## 成本预估

您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至2022年6月,影响解决方案的成本因素主要包括:
您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至这次发布的版本,影响解决方案的成本因素主要包括:

- Amazon Lambda调用次数
- Amazon Lambda运行时间
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-branded/include-deploy-cost-10GB.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 成本预估

您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至2022年6月,影响解决方案的成本因素主要包括:
您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至这次发布的版本,影响解决方案的成本因素主要包括:

- Amazon API Gateway调用次数
- Amazon API Gateway数据输出量
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-branded/include-deploy-cost-8GB.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 成本预估

您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至2022年6月,影响解决方案的成本因素主要包括:
您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至这次发布的版本,影响解决方案的成本因素主要包括:

- Amazon API Gateway调用次数
- Amazon API Gateway数据输出量
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/cost.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 成本预估

您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至2022年12月,影响解决方案的成本因素主要包括:
您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至这次发布的版本,影响解决方案的成本因素主要包括:

- Amazon API Gateway调用次数
- Amazon API Gateway数据输出量
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/deploy-general-nlu.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ feature_scenario: 用于文本分类、情感分析、文本匹配和实体识

## 成本预估

您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至2022年6月,影响解决方案的成本因素主要包括:
您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至这次发布的版本,影响解决方案的成本因素主要包括:

- AWS Lambda调用次数
- AWS Lambda运行时间
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/deploy-image-super-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ feature_scenario: 可应用于等多种场景,解决原始图片分辨率不

## 成本预估

您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至2022年6月,影响解决方案的成本因素主要包括:
您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至这次发布的版本,影响解决方案的成本因素主要包括:

- Amazon API Gateway调用次数
- Amazon API Gateway数据输出量
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/deploy-text-similarity.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ feature_scenario: 可应用于搜索引擎、推荐系统、机器翻译、自

## 成本预估

您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至2022年6月,影响解决方案的成本因素主要包括:
您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至这次发布的版本,影响解决方案的成本因素主要包括:

- AWS Lambda调用次数
- AWS Lambda运行时间
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/include-deploy-cost-10GB.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 成本预估

您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至2022年6月,影响解决方案的成本因素主要包括:
您需要承担运行解决方案时使用亚马逊云科技各个服务的成本费用。截至这次发布的版本,影响解决方案的成本因素主要包括:

- Amazon API Gateway调用次数
- Amazon API Gateway数据输出量
Expand Down
Loading

0 comments on commit 8081215

Please sign in to comment.