Skip to content

P
PaddleHub

PaddlePaddle / PaddleHub
大约 2 年 前同步成功

通知 285
Star 12117
Fork 2091
P
PaddleHub
提交 4c07f02d 编写于 作者: H haoyuying
浏览文件
操作

add en version readme for model 400

上级 336893a5
显示空白变更内容
内联 并排
Showing with 829 addition and 809 deletion
modules/image/Image_editing/colorization/deoldify/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
| Module Name |deoldify| | Module Name |deoldify|
| :--- | :---: | | :--- | :---: |
|Category|image editing| |Category|Image editing|
|Network |NoGAN| |Network |NoGAN|
|Dataset|ILSVRC 2012| |Dataset|ILSVRC 2012|
|Fine-tuning supported or not |No| |Fine-tuning supported or not |No|
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
- ### Module Introduction - ### Module Introduction
- deoldify is a color rendering model for images and videos, which can restore color for black and white photos and videos. - Deoldify is a color rendering model for images and videos, which can restore color for black and white photos and videos.
- For more information, please refer to: [deoldify](https://github.com/jantic/DeOldify) - For more information, please refer to: [deoldify](https://github.com/jantic/DeOldify)
...@@ -46,15 +46,15 @@ ...@@ -46,15 +46,15 @@
$ hub install deoldify $ hub install deoldify
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
- ### 1、Prediction Code Example - ### 1、Prediction Code Example
```python - ```python
import paddlehub as hub import paddlehub as hub
model = hub.Module(name='deoldify') model = hub.Module(name='deoldify')
...@@ -71,16 +71,16 @@ ...@@ -71,16 +71,16 @@
- **Parameter** - **Parameter**
- input (str): image path. - input (str): Image path.
- **Return** - **Return**
- If input is image path, the output is： - If input is image path, the output is：
- pred_img(np.ndarray): image data, ndarray.shape is in the format [H, W, C], BGR; - pred_img(np.ndarray): image data, ndarray.shape is in the format [H, W, C], BGR.
- out_path(str): save path of images. - out_path(str): save path of images.
- If input is video path, the output is ： - If input is video path, the output is ：
- frame_pattern_combined(str): save path of frames from output video; - frame_pattern_combined(str): save path of frames from output video.
- vid_out_path(str): save path of output video. - vid_out_path(str): save path of output video.
- ```python - ```python
...@@ -90,11 +90,11 @@ ...@@ -90,11 +90,11 @@
- **Parameter** - **Parameter**
- img (str｜np.ndarray): image data, str or ndarray. ndarray.shape is in the format [H, W, C], BGR. - img (str｜np.ndarray): Image data, str or ndarray. ndarray.shape is in the format [H, W, C], BGR.
- **Return** - **Return**
- pred_img(np.ndarray): ndarray.shape is in the format [H, W, C], BGR. - pred_img(np.ndarray): Ndarray.shape is in the format [H, W, C], BGR.
- ```python - ```python
def run_video(self, video): def run_video(self, video):
...@@ -103,12 +103,12 @@ ...@@ -103,12 +103,12 @@
- **Parameter** - **Parameter**
- video(str): video path. - video(str): Video path.
- **Return** - **Return**
- frame_pattern_combined(str): save path of frames from output video; - frame_pattern_combined(str): Save path of frames from output video.
- vid_out_path(str): save path of output video. - vid_out_path(str): Save path of output video.
## IV. Server Deployment ## IV. Server Deployment
......
modules/image/Image_editing/colorization/photo_restoration/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name|photo_restoration| |Module Name|photo_restoration|
| :--- | :---: | | :--- | :---: |
|Category|image editing| |Category|Image editing|
|Network|deoldify and realsr| |Network|deoldify and realsr|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
|Module Size |64MB+834MB| |Module Size |64MB+834MB|
...@@ -47,8 +47,8 @@ ...@@ -47,8 +47,8 @@
$ hub install photo_restoration $ hub install photo_restoration
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -56,7 +56,7 @@ ...@@ -56,7 +56,7 @@
- ### 1、Prediction Code Example - ### 1、Prediction Code Example
```python - ```python
import cv2 import cv2
import paddlehub as hub import paddlehub as hub
...@@ -68,7 +68,7 @@ ...@@ -68,7 +68,7 @@
- ### 2、API - ### 2、API
```python - ```python
def run_image(self, def run_image(self,
input, input,
model_select= ['Colorization', 'SuperResolution'], model_select= ['Colorization', 'SuperResolution'],
...@@ -79,16 +79,16 @@ ...@@ -79,16 +79,16 @@
- **Parameter** - **Parameter**
- input (numpy.ndarray｜str): image data，numpy.ndarray or str. ndarray.shape is in the format [H, W, C], BGR; - input (numpy.ndarray｜str): Image data，numpy.ndarray or str. ndarray.shape is in the format [H, W, C], BGR.
- model_select (list\[str\]): Mode selection，\['Colorization'\] only colorize the input image， \['SuperResolution'\] only increase the image resolution； - model_select (list\[str\]): Mode selection，\['Colorization'\] only colorize the input image， \['SuperResolution'\] only increase the image resolution；
default is \['Colorization', 'SuperResolution'\]。 default is \['Colorization', 'SuperResolution'\]。
- save_path (str): save path, default is 'photo_restoration'. - save_path (str): Save path, default is 'photo_restoration'.
- **Return** - **Return**
- output (numpy.ndarray): restoration result，ndarray.shape is in the format [H, W, C], BGR. - output (numpy.ndarray): Restoration result，ndarray.shape is in the format [H, W, C], BGR.
## IV. Server Deployment ## IV. Server Deployment
...@@ -111,7 +111,7 @@ ...@@ -111,7 +111,7 @@
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
```python - ```python
import requests import requests
import json import json
import base64 import base64
......
modules/image/Image_editing/colorization/user_guided_colorization/README_en.md
浏览文件 @ 4c07f02d
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
- ### Module Introduction - ### Module Introduction
- user_guided_colorization is a colorization model based on "Real-Time User-Guided Image Colorization with Learned Deep Priors"，this model uses pre-supplied coloring blocks to color the gray image. - User_guided_colorization is a colorization model based on "Real-Time User-Guided Image Colorization with Learned Deep Priors"，this model uses pre-supplied coloring blocks to color the gray image.
## II. Installation ## II. Installation
...@@ -40,8 +40,8 @@ ...@@ -40,8 +40,8 @@
$ hub install user_guided_colorization $ hub install user_guided_colorization
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to: [Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -50,6 +50,8 @@ ...@@ -50,6 +50,8 @@
```shell ```shell
$ hub run user_guided_colorization --input_path "/PATH/TO/IMAGE" $ hub run user_guided_colorization --input_path "/PATH/TO/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
```python ```python
...@@ -69,6 +71,7 @@ ...@@ -69,6 +71,7 @@
- Steps: - Steps:
- Step1: Define the data preprocessing method - Step1: Define the data preprocessing method
- ```python - ```python
import paddlehub.vision.transforms as T import paddlehub.vision.transforms as T
...@@ -77,7 +80,7 @@ ...@@ -77,7 +80,7 @@
T.RGB2LAB()], to_rgb=True) T.RGB2LAB()], to_rgb=True)
``` ```
- `transforms` The data enhancement module defines lots of data preprocessing methods. Users can replace the data preprocessing methods according to their needs. - `transforms`: The data enhancement module defines lots of data preprocessing methods. Users can replace the data preprocessing methods according to their needs.
- Step2: Download the dataset - Step2: Download the dataset
- ```python - ```python
...@@ -86,9 +89,9 @@ ...@@ -86,9 +89,9 @@
color_set = Canvas(transform=transform, mode='train') color_set = Canvas(transform=transform, mode='train')
``` ```
* `transforms`: data preprocessing methods. * `transforms`: Data preprocessing methods.
* `mode`: Select the data mode, the options are `train`, `test`, `val`. Default is `train`. * `mode`: Select the data mode, the options are `train`, `test`, `val`. Default is `train`.
* `hub.datasets.Canvas()` The dataset will be automatically downloaded from the network and decompressed to the `$HOME/.paddlehub/dataset` directory under the user directory. * `hub.datasets.Canvas()`: The dataset will be automatically downloaded from the network and decompressed to the `$HOME/.paddlehub/dataset` directory under the user directory.
- Step3: Load the pre-trained model - Step3: Load the pre-trained model
...@@ -97,7 +100,7 @@ ...@@ -97,7 +100,7 @@
model = hub.Module(name='user_guided_colorization', load_checkpoint=None) model = hub.Module(name='user_guided_colorization', load_checkpoint=None)
model.set_config(classification=True, prob=1) model.set_config(classification=True, prob=1)
``` ```
* `name`: model name. * `name`: Model name.
* `load_checkpoint`: Whether to load the self-trained model, if it is None, load the provided parameters. * `load_checkpoint`: Whether to load the self-trained model, if it is None, load the provided parameters.
* `classification`: The model is trained by two mode. At the beginning, `classification` is set to True, which is used for shallow network training. In the later stage of training, set `classification` to False, which is used to train the output layer of the network. * `classification`: The model is trained by two mode. At the beginning, `classification` is set to True, which is used for shallow network training. In the later stage of training, set `classification` to False, which is used to train the output layer of the network.
* `prob`: The probability that a priori color block is not added to each input image, the default is 1, that is, no prior color block is added. For example, when `prob` is set to 0.9, the probability that there are two a priori color blocks on a picture is(1-0.9)*(1-0.9)*0.9=0.009. * `prob`: The probability that a priori color block is not added to each input image, the default is 1, that is, no prior color block is added. For example, when `prob` is set to 0.9, the probability that there are two a priori color blocks on a picture is(1-0.9)*(1-0.9)*0.9=0.009.
...@@ -115,20 +118,20 @@ ...@@ -115,20 +118,20 @@
- `Trainer` mainly control the training of Fine-tune, including the following controllable parameters: - `Trainer` mainly control the training of Fine-tune, including the following controllable parameters:
* `model`: Optimized model; * `model`: Optimized model.
* `optimizer`: Optimizer selection; * `optimizer`: Optimizer selection.
* `use_vdl`: Whether to use vdl to visualize the training process; * `use_vdl`: Whether to use vdl to visualize the training process.
* `checkpoint_dir`: The storage address of the model parameters; * `checkpoint_dir`: The storage address of the model parameters.
* `compare_metrics`: The measurement index of the optimal model; * `compare_metrics`: The measurement index of the optimal model.
- `trainer.train` mainly control the specific training process, including the following controllable parameters: - `trainer.train` mainly control the specific training process, including the following controllable parameters:
* `train_dataset`: Training dataset; * `train_dataset`: Training dataset.
* `epochs`: Epochs of training process; * `epochs`: Epochs of training process.
* `batch_size`: Batch size; * `batch_size`: Batch size.
* `num_workers`: Number of workers. * `num_workers`: Number of workers.
* `eval_dataset`: Validation dataset; * `eval_dataset`: Validation dataset.
* `log_interval`:The interval for printing logs; * `log_interval`:The interval for printing logs.
* `save_interval`: The interval for saving model parameters. * `save_interval`: The interval for saving model parameters.
- Model prediction - Model prediction
...@@ -167,8 +170,7 @@ ...@@ -167,8 +170,7 @@
- ### Step 2: Send a predictive request - ### Step 2: Send a predictive request
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
- ```python
```python
import requests import requests
import json import json
import cv2 import cv2
......
modules/image/Image_editing/super_resolution/dcscn/README_en.md
浏览文件 @ 4c07f02d
# dcscn # dcscn
|Module Name|dcscn| |Module Name|dcscn|
| :--- | :---: | | :--- | :---: |
|Category |Image editing| |Category |Image editing|
...@@ -8,7 +7,7 @@ ...@@ -8,7 +7,7 @@
|Dataset|DIV2k| |Dataset|DIV2k|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
|Module Size|260KB| |Module Size|260KB|
|指标|PSNR37.63| |Data indicators|PSNR37.63|
|Data indicators |2021-02-26| |Data indicators |2021-02-26|
...@@ -43,8 +42,8 @@ ...@@ -43,8 +42,8 @@
$ hub install dcscn $ hub install dcscn
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -53,9 +52,11 @@ ...@@ -53,9 +52,11 @@
- ``` - ```
$ hub run dcscn --input_path "/PATH/TO/IMAGE" $ hub run dcscn --input_path "/PATH/TO/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
```python - ```python
import cv2 import cv2
import paddlehub as hub import paddlehub as hub
...@@ -81,16 +82,16 @@ ...@@ -81,16 +82,16 @@
- **Parameter** - **Parameter**
* images (list\[numpy.ndarray\]): image data，ndarray.shape is in the format \[H, W, C\]，BGR; * images (list\[numpy.ndarray\]): Image data，ndarray.shape is in the format \[H, W, C\]，BGR.
* paths (list\[str\]): image path; * paths (list\[str\]): image path.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**; * use\_gpu (bool): Use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**.
* visualization (bool): Whether to save the recognition results as picture files; * visualization (bool): Whether to save the recognition results as picture files.
* output\_dir (str): save path of images, "dcscn_output" by default. * output\_dir (str): Save path of images, "dcscn_output" by default.
- **Return** - **Return**
* res (list\[dict\]): The list of model results, where each element is dict and each field is: * res (list\[dict\]): The list of model results, where each element is dict and each field is:
* save\_path (str, optional): Save path of the result, save_path is '' if no image is saved. * save\_path (str, optional): Save path of the result, save_path is '' if no image is saved.
* data (numpy.ndarray): result of super resolution. * data (numpy.ndarray): Result of super resolution.
- ```python - ```python
def save_inference_model(self, def save_inference_model(self,
...@@ -105,8 +106,8 @@ ...@@ -105,8 +106,8 @@
- **Parameters** - **Parameters**
* dirname: Save path. * dirname: Save path.
* model\_filename: model file name，defalt is \_\_model\_\_ * model\_filename: Model file name，defalt is \_\_model\_\_
* params\_filename: parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True) * params\_filename: Parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True)
* combined: Whether to save the parameters to a unified file. * combined: Whether to save the parameters to a unified file.
...@@ -131,7 +132,7 @@ ...@@ -131,7 +132,7 @@
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
```python - ```python
import requests import requests
import json import json
import base64 import base64
......
modules/image/Image_editing/super_resolution/falsr_a/README_en.md
浏览文件 @ 4c07f02d
...@@ -23,9 +23,9 @@ ...@@ -23,9 +23,9 @@
- ### Module Introduction - ### Module Introduction
- falsr_a is a lightweight super-resolution model based on `Accurate and Lightweight Super-Resolution with Neural Architecture Search`. The model uses a multi-objective approach to deal with the over-segmentation problem, and uses an elastic search strategy based on a hybrid controller to improve the performance of the model. This model provides super resolution result with scale factor x2. - Falsr_a is a lightweight super-resolution model based on "Accurate and Lightweight Super-Resolution with Neural Architecture Search". The model uses a multi-objective approach to deal with the over-segmentation problem, and uses an elastic search strategy based on a hybrid controller to improve the performance of the model. This model provides super resolution result with scale factor x2.
- For more information, please refer to:[falsr_a](https://github.com/xiaomi-automl/FALSR) - For more information, please refer to: [falsr_a](https://github.com/xiaomi-automl/FALSR)
## II. Installation ## II. Installation
...@@ -42,8 +42,8 @@ ...@@ -42,8 +42,8 @@
$ hub install falsr_a $ hub install falsr_a
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -53,10 +53,11 @@ ...@@ -53,10 +53,11 @@
- ``` - ```
$ hub run falsr_a --input_path "/PATH/TO/IMAGE" $ hub run falsr_a --input_path "/PATH/TO/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
```python - ```python
import cv2 import cv2
import paddlehub as hub import paddlehub as hub
...@@ -82,10 +83,10 @@ ...@@ -82,10 +83,10 @@
- **Parameter** - **Parameter**
* images (list\[numpy.ndarray\]): image data，ndarray.shape is in the format \[H, W, C\]，BGR; * images (list\[numpy.ndarray\]): image data，ndarray.shape is in the format \[H, W, C\]，BGR.
* paths (list\[str\]): image path; * paths (list\[str\]): image path.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**; * use\_gpu (bool): use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**.
* visualization (bool): Whether to save the recognition results as picture files; * visualization (bool): Whether to save the recognition results as picture files.
* output\_dir (str): save path of images, "dcscn_output" by default. * output\_dir (str): save path of images, "dcscn_output" by default.
- **Return** - **Return**
...@@ -134,7 +135,7 @@ ...@@ -134,7 +135,7 @@
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
```python - ```python
import requests import requests
import json import json
import base64 import base64
......
modules/image/Image_editing/super_resolution/falsr_b/README_en.md
浏览文件 @ 4c07f02d
...@@ -23,7 +23,7 @@ ...@@ -23,7 +23,7 @@
- ### Module Introduction - ### Module Introduction
- falsr_b is a lightweight super-resolution model based on `Accurate and Lightweight Super-Resolution with Neural Architecture Search`. The model uses a multi-objective approach to deal with the over-segmentation problem, and uses an elastic search strategy based on a hybrid controller to improve the performance of the model. This model provides super resolution result with scale factor x2. - Falsr_b is a lightweight super-resolution model based on "Accurate and Lightweight Super-Resolution with Neural Architecture Search". The model uses a multi-objective approach to deal with the over-segmentation problem, and uses an elastic search strategy based on a hybrid controller to improve the performance of the model. This model provides super resolution result with scale factor x2.
- For more information, please refer to:[falsr_b](https://github.com/xiaomi-automl/FALSR) - For more information, please refer to:[falsr_b](https://github.com/xiaomi-automl/FALSR)
...@@ -42,8 +42,8 @@ ...@@ -42,8 +42,8 @@
$ hub install falsr_b $ hub install falsr_b
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -53,6 +53,7 @@ ...@@ -53,6 +53,7 @@
- ``` - ```
$ hub run falsr_b --input_path "/PATH/TO/IMAGE" $ hub run falsr_b --input_path "/PATH/TO/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
...@@ -82,16 +83,16 @@ ...@@ -82,16 +83,16 @@
- **Parameter** - **Parameter**
* images (list\[numpy.ndarray\]): image data，ndarray.shape is in the format \[H, W, C\]，BGR; * images (list\[numpy.ndarray\]): Image data，ndarray.shape is in the format \[H, W, C\]，BGR.
* paths (list\[str\]): image path; * paths (list\[str\]): Image path.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**; * use\_gpu (bool): Use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**.
* visualization (bool): Whether to save the recognition results as picture files; * visualization (bool): Whether to save the recognition results as picture files.
* output\_dir (str): save path of images, "dcscn_output" by default. * output\_dir (str): Save path of images, "dcscn_output" by default.
- **Return** - **Return**
* res (list\[dict\]): The list of model results, where each element is dict and each field is: * res (list\[dict\]): The list of model results, where each element is dict and each field is:
* save\_path (str, optional): Save path of the result, save_path is '' if no image is saved. * save\_path (str, optional): Save path of the result, save_path is '' if no image is saved.
* data (numpy.ndarray): result of super resolution. * data (numpy.ndarray): Result of super resolution.
- ```python - ```python
def save_inference_model(self, def save_inference_model(self,
...@@ -106,8 +107,8 @@ ...@@ -106,8 +107,8 @@
- **Parameters** - **Parameters**
* dirname: Save path. * dirname: Save path.
* model\_filename: model file name，defalt is \_\_model\_\_ * model\_filename: Model file name，defalt is \_\_model\_\_
* params\_filename: parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True) * params\_filename: Parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True)
* combined: Whether to save the parameters to a unified file. * combined: Whether to save the parameters to a unified file.
...@@ -134,7 +135,7 @@ ...@@ -134,7 +135,7 @@
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
```python - ```python
import requests import requests
import json import json
import base64 import base64
......
modules/image/Image_editing/super_resolution/falsr_c/README_en.md
浏览文件 @ 4c07f02d
...@@ -23,7 +23,7 @@ ...@@ -23,7 +23,7 @@
- ### Module Introduction - ### Module Introduction
- falsr_c is a lightweight super-resolution model based on `Accurate and Lightweight Super-Resolution with Neural Architecture Search`. The model uses a multi-objective approach to deal with the over-segmentation problem, and uses an elastic search strategy based on a hybrid controller to improve the performance of the model. This model provides super resolution result with scale factor x2. - Falsr_c is a lightweight super-resolution model based on "Accurate and Lightweight Super-Resolution with Neural Architecture Search". The model uses a multi-objective approach to deal with the over-segmentation problem, and uses an elastic search strategy based on a hybrid controller to improve the performance of the model. This model provides super resolution result with scale factor x2.
- For more information, please refer to:[falsr_c](https://github.com/xiaomi-automl/FALSR) - For more information, please refer to:[falsr_c](https://github.com/xiaomi-automl/FALSR)
...@@ -42,8 +42,8 @@ ...@@ -42,8 +42,8 @@
$ hub install falsr_c $ hub install falsr_c
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -53,6 +53,7 @@ ...@@ -53,6 +53,7 @@
- ``` - ```
$ hub run falsr_c --input_path "/PATH/TO/IMAGE" $ hub run falsr_c --input_path "/PATH/TO/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
...@@ -82,16 +83,16 @@ ...@@ -82,16 +83,16 @@
- **Parameter** - **Parameter**
* images (list\[numpy.ndarray\]): image data，ndarray.shape is in the format \[H, W, C\]，BGR; * images (list\[numpy.ndarray\]): Image data，ndarray.shape is in the format \[H, W, C\]，BGR.
* paths (list\[str\]): image path; * paths (list\[str\]): Image path.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**; * use\_gpu (bool): Use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**.
* visualization (bool): Whether to save the recognition results as picture files; * visualization (bool): Whether to save the recognition results as picture files.
* output\_dir (str): save path of images, "dcscn_output" by default. * output\_dir (str): Save path of images, "dcscn_output" by default.
- **Return** - **Return**
* res (list\[dict\]): The list of model results, where each element is dict and each field is: * res (list\[dict\]): The list of model results, where each element is dict and each field is:
* save\_path (str, optional): Save path of the result, save_path is '' if no image is saved. * save\_path (str, optional): Save path of the result, save_path is '' if no image is saved.
* data (numpy.ndarray): result of super resolution. * data (numpy.ndarray): Result of super resolution.
- ```python - ```python
def save_inference_model(self, def save_inference_model(self,
...@@ -106,8 +107,8 @@ ...@@ -106,8 +107,8 @@
- **Parameters** - **Parameters**
* dirname: Save path. * dirname: Save path.
* model\_filename: model file name，defalt is \_\_model\_\_ * model\_filename: Model file name，defalt is \_\_model\_\_
* params\_filename: parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True) * params\_filename: Parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True)
* combined: Whether to save the parameters to a unified file. * combined: Whether to save the parameters to a unified file.
...@@ -134,7 +135,7 @@ ...@@ -134,7 +135,7 @@
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
```python - ```python
import requests import requests
import json import json
import base64 import base64
......
modules/image/Image_editing/super_resolution/realsr/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name |reasr| |Module Name |reasr|
| :--- | :---: | | :--- | :---: |
|Category |image editing| |Category |Image editing|
|Network|LP-KPN| |Network|LP-KPN|
|Dataset |RealSR dataset| |Dataset |RealSR dataset|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -23,7 +23,7 @@ ...@@ -23,7 +23,7 @@
- ### Module Introduction - ### Module Introduction
- realsr is a super resolution model for image and video based on "Toward Real-World Single Image Super-Resolution: A New Benchmark and A New Mode". This model provides super resolution result with scale factor x4. - Realsr is a super resolution model for image and video based on "Toward Real-World Single Image Super-Resolution: A New Benchmark and A New Mode". This model provides super resolution result with scale factor x4.
- For more information, please refer to: [realsr](https://github.com/csjcai/RealSR) - For more information, please refer to: [realsr](https://github.com/csjcai/RealSR)
...@@ -47,8 +47,8 @@ ...@@ -47,8 +47,8 @@
$ hub install realsr $ hub install realsr
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
...@@ -56,7 +56,7 @@ ...@@ -56,7 +56,7 @@
- ### 1、Prediction Code Example - ### 1、Prediction Code Example
```python - ```python
import paddlehub as hub import paddlehub as hub
model = hub.Module(name='realsr') model = hub.Module(name='realsr')
...@@ -77,11 +77,11 @@ ...@@ -77,11 +77,11 @@
- **Return** - **Return**
- If input is image path, the output is： - If input is image path, the output is：
- pred_img(np.ndarray): image data, ndarray.shape is in the format [H, W, C], BGR; - pred_img(np.ndarray): image data, ndarray.shape is in the format [H, W, C], BGR.
- out_path(str): save path of images. - out_path(str): save path of images.
- If input is video path, the output is ： - If input is video path, the output is ：
- frame_pattern_combined(str): save path of frames from output video; - frame_pattern_combined(str): save path of frames from output video.
- vid_out_path(str): save path of output video. - vid_out_path(str): save path of output video.
- ```python - ```python
...@@ -91,11 +91,11 @@ ...@@ -91,11 +91,11 @@
- **Parameter** - **Parameter**
- img (str｜np.ndarray): image data, str or ndarray. ndarray.shape is in the format [H, W, C], BGR. - img (str｜np.ndarray): Image data, str or ndarray. ndarray.shape is in the format [H, W, C], BGR.
- **Return** - **Return**
- pred_img(np.ndarray): ndarray.shape is in the format [H, W, C], BGR. - pred_img(np.ndarray): Prediction result, ndarray.shape is in the format [H, W, C], BGR.
- ```python - ```python
def run_video(self, video): def run_video(self, video):
...@@ -104,12 +104,12 @@ ...@@ -104,12 +104,12 @@
- **Parameter** - **Parameter**
- video(str): video path. - video(str): Video path.
- **Return** - **Return**
- frame_pattern_combined(str): save path of frames from output video; - frame_pattern_combined(str): Save path of frames from output video.
- vid_out_path(str): save path of output video. - vid_out_path(str): Save path of output video.
## IV. Server Deployment ## IV. Server Deployment
...@@ -149,7 +149,7 @@ ...@@ -149,7 +149,7 @@
data = cv2.imdecode(data, cv2.IMREAD_COLOR) data = cv2.imdecode(data, cv2.IMREAD_COLOR)
return data return data
# 发送HTTP请求
org_im = cv2.imread('/PATH/TO/IMAGE') org_im = cv2.imread('/PATH/TO/IMAGE')
data = {'images':cv2_to_base64(org_im)} data = {'images':cv2_to_base64(org_im)}
headers = {"Content-type": "application/json"} headers = {"Content-type": "application/json"}
......
modules/image/Image_gan/attgan_celeba/README_en.md
浏览文件 @ 4c07f02d
...@@ -33,7 +33,7 @@ ...@@ -33,7 +33,7 @@
- paddlepaddle >= 1.5.2 - paddlepaddle >= 1.5.2
- paddlehub >= 1.0.0 | [How to install PaddleHub](../../../../docs/docs_ch/get_start/installation.rst) - paddlehub >= 1.0.0 | [How to install PaddleHub](../../../../docs/docs_en/get_start/installation.rst)
- ### 2、Installation - ### 2、Installation
...@@ -41,8 +41,8 @@ ...@@ -41,8 +41,8 @@
$ hub install attgan_celeba==1.0.0 $ hub install attgan_celeba==1.0.0
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md). | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md).
...@@ -56,10 +56,13 @@ ...@@ -56,10 +56,13 @@
- **Parameters** - **Parameters**
- image: image path - image: Input image path.
- style: Specify the attributes to be converted. The options are "Bald", "Bangs", "Black_Hair", "Blond_Hair", "Brown_Hair", "Bushy_Eyebrows", "Eyeglasses", "Gender", "Mouth_Slightly_Open", "Mustache", "No_Beard", "Pale_Skin", "Aged". You can choose one of the options. - style: Specify the attributes to be converted. The options are "Bald", "Bangs", "Black_Hair", "Blond_Hair", "Brown_Hair", "Bushy_Eyebrows", "Eyeglasses", "Gender", "Mouth_Slightly_Open", "Mustache", "No_Beard", "Pale_Skin", "Aged". You can choose one of the options.
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
...@@ -89,7 +92,7 @@ ...@@ -89,7 +92,7 @@
- **Parameter** - **Parameter**
- data(list[dict]): each element in the list is dict and each field is: - data(list[dict]): Each element in the list is dict and each field is:
- image (list\[str\])： Each element in the list is the path of the image to be converted. - image (list\[str\])： Each element in the list is the path of the image to be converted.
- style (list\[str\])： Each element in the list is a string, fill in the face attributes to be converted. - style (list\[str\])： Each element in the list is a string, fill in the face attributes to be converted.
......
modules/image/Image_gan/cyclegan_cityscapes/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name|cyclegan_cityscapes| |Module Name|cyclegan_cityscapes|
| :--- | :---: | | :--- | :---: |
|Category |image generation| |Category |Image generation|
|Network |CycleGAN| |Network |CycleGAN|
|Dataset|Cityscapes| |Dataset|Cityscapes|
|Fine-tuning supported or not |No| |Fine-tuning supported or not |No|
...@@ -32,7 +32,6 @@ ...@@ -32,7 +32,6 @@
- ### Module Introduction - ### Module Introduction
- CycleGAN是生成对抗网络（Generative Adversarial Networks ）的一种，与传统的GAN只能单向生成图片不同，CycleGAN可以同时完成两个domain的图片进行相互转换。该PaddleHub Module使用Cityscapes数据集训练完成，支持图片从实景图转换为语义分割结果，也支持从语义分割结果转换为实景图。
- CycleGAN belongs to Generative Adversarial Networks(GANs). Unlike traditional GANs that can only generate pictures in one direction, CycleGAN can simultaneously complete the style transfer of two domains. The PaddleHub Module is trained by Cityscapes dataset, and supports the conversion from real images to semantic segmentation results, and also supports conversion from semantic segmentation results to real images. - CycleGAN belongs to Generative Adversarial Networks(GANs). Unlike traditional GANs that can only generate pictures in one direction, CycleGAN can simultaneously complete the style transfer of two domains. The PaddleHub Module is trained by Cityscapes dataset, and supports the conversion from real images to semantic segmentation results, and also supports conversion from semantic segmentation results to real images.
...@@ -42,15 +41,15 @@ ...@@ -42,15 +41,15 @@
- paddlepaddle >= 1.4.0 - paddlepaddle >= 1.4.0
- paddlehub >= 1.1.0 | [How to install PaddleHub](../../../../docs/docs_ch/get_start/installation.rst) - paddlehub >= 1.1.0
- ### 2、Installation - ### 2、Installation
- ```shell - ```shell
$ hub install cyclegan_cityscapes==1.0.0 $ hub install cyclegan_cityscapes==1.0.0
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -59,9 +58,11 @@ ...@@ -59,9 +58,11 @@
- ```shell - ```shell
$ hub run cyclegan_cityscapes --input_path "/PATH/TO/IMAGE" $ hub run cyclegan_cityscapes --input_path "/PATH/TO/IMAGE"
``` ```
- **Parameters** - **Parameters**
- input_path: image path - input_path: image path
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
...@@ -90,13 +91,13 @@ ...@@ -90,13 +91,13 @@
- **Parameters** - **Parameters**
- data(list[dict]): each element in the list is dict and each field is: - data(list[dict]): Each element in the list is dict and each field is:
- image (list\[str\])： image path. - image (list\[str\])： Image path.
- **Return** - **Return**
- res (list\[str\]): The list of style transfer results, where each element is dict and each field is: - res (list\[str\]): The list of style transfer results, where each element is dict and each field is:
- origin: original input path. - origin: Original input path.
- generated: save path of images. - generated: Save path of images.
......
modules/image/Image_gan/stargan_celeba/README_en.md
浏览文件 @ 4c07f02d
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
|Category|image generation| |Category|image generation|
|Network|STGAN| |Network|STGAN|
|Dataset|Celeba| |Dataset|Celeba|
|Fine-tuning supported or not|否| |Fine-tuning supported or not|No|
|Module Size |33MB| |Module Size |33MB|
|Latest update date|2021-02-26| |Latest update date|2021-02-26|
|Data indicators|-| |Data indicators|-|
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
- ### Module Introduction - ### Module Introduction
- STGAN takes the difference between the original attribute and the target attribute as input, and proposes STUs (Selective transfer units) to select and modify features of the encoder. The PaddleHub Module is trained one Celeba dataset and currently supports attributes of "Black_Hair", "Blond_Hair", "Brown_Hair", "Female", "Male", "Aged". - STGAN takes the original attribute and the target attribute as input, and proposes STUs (Selective transfer units) to select and modify features of the encoder. The PaddleHub Module is trained one Celeba dataset and currently supports attributes of "Black_Hair", "Blond_Hair", "Brown_Hair", "Female", "Male", "Aged".
## II. Installation ## II. Installation
...@@ -40,8 +40,8 @@ ...@@ -40,8 +40,8 @@
- ```shell - ```shell
$ hub install stargan_celeba==1.0.0 $ hub install stargan_celeba==1.0.0
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -58,6 +58,8 @@ ...@@ -58,6 +58,8 @@
- style: Specify the attributes to be converted. The options are "Black_Hair", "Blond_Hair", "Brown_Hair", "Female", "Male", "Aged". You can choose one of the options. - style: Specify the attributes to be converted. The options are "Black_Hair", "Blond_Hair", "Brown_Hair", "Female", "Male", "Aged". You can choose one of the options.
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
- ```python - ```python
......
modules/image/Image_gan/stgan_celeba/README_en.md
浏览文件 @ 4c07f02d
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
|Category|image generation| |Category|image generation|
|Network|STGAN| |Network|STGAN|
|Dataset|Celeba| |Dataset|Celeba|
|Fine-tuning supported or not|否| |Fine-tuning supported or not|No|
|Module Size |287MB| |Module Size |287MB|
|Latest update date|2021-02-26| |Latest update date|2021-02-26|
|Data indicators|-| |Data indicators|-|
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
- ### Module Introduction - ### Module Introduction
- STGAN takes the difference between the original attribute and the target attribute as input, and proposes STUs (Selective transfer units) to select and modify features of the encoder. The PaddleHub Module is trained one Celeba dataset and currently supports attributes of "Bald", "Bangs", "Black_Hair", "Blond_Hair", "Brown_Hair", "Bushy_Eyebrows", "Eyeglasses", "Gender", "Mouth_Slightly_Open", "Mustache", "No_Beard", "Pale_Skin", "Aged". - STGAN takes the original attribute and the target attribute as input, and proposes STUs (Selective transfer units) to select and modify features of the encoder. The PaddleHub Module is trained one Celeba dataset and currently supports attributes of "Bald", "Bangs", "Black_Hair", "Blond_Hair", "Brown_Hair", "Bushy_Eyebrows", "Eyeglasses", "Gender", "Mouth_Slightly_Open", "Mustache", "No_Beard", "Pale_Skin", "Aged".
## II. Installation ## II. Installation
...@@ -40,8 +40,8 @@ ...@@ -40,8 +40,8 @@
- ```shell - ```shell
$ hub install stgan_celeba==1.0.0 $ hub install stgan_celeba==1.0.0
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -53,11 +53,12 @@ ...@@ -53,11 +53,12 @@
``` ```
- **Parameters** - **Parameters**
- image: image path - image: Image path
- info: attributes of original image, must fill in gender（ "Male" or "Female").The options are "Bald", "Bangs", "Black_Hair", "Blond_Hair", "Brown_Hair", "Bushy_Eyebrows", "Eyeglasses", "Mouth_Slightly_Open", "Mustache", "No_Beard", "Pale_Skin", "Aged". For example, the input picture is a girl with black hair, then fill in as "Female,Black_Hair". - info: Attributes of original image, must fill in gender（ "Male" or "Female").The options are "Bald", "Bangs", "Black_Hair", "Blond_Hair", "Brown_Hair", "Bushy_Eyebrows", "Eyeglasses", "Mouth_Slightly_Open", "Mustache", "No_Beard", "Pale_Skin", "Aged". For example, the input picture is a girl with black hair, then fill in as "Female,Black_Hair".
- style: Specify the attributes to be converted. The options are "Bald", "Bangs", "Black_Hair", "Blond_Hair", "Brown_Hair", "Bushy_Eyebrows", "Eyeglasses", "Gender", "Mouth_Slightly_Open", "Mustache", "No_Beard", "Pale_Skin", "Aged". You can choose one of the options. - style: Specify the attributes to be converted. The options are "Bald", "Bangs", "Black_Hair", "Blond_Hair", "Brown_Hair", "Bushy_Eyebrows", "Eyeglasses", "Gender", "Mouth_Slightly_Open", "Mustache", "No_Beard", "Pale_Skin", "Aged". You can choose one of the options.
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
...@@ -88,7 +89,7 @@ ...@@ -88,7 +89,7 @@
- **Parameter** - **Parameter**
- data(list[dict]): each element in the list is dict and each field is: - data(list[dict]): Each element in the list is dict and each field is:
- image (list\[str\])： Each element in the list is the path of the image to be converted. - image (list\[str\])： Each element in the list is the path of the image to be converted.
- style (list\[str\])： Each element in the list is a string, fill in the face attributes to be converted. - style (list\[str\])： Each element in the list is a string, fill in the face attributes to be converted.
- info (list\[str\])： Represents the face attributes of the original image. Different attributes are separated by commas. - info (list\[str\])： Represents the face attributes of the original image. Different attributes are separated by commas.
......
modules/image/Image_gan/style_transfer/ID_Photo_GEN/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name |ID_Photo_GEN| |Module Name |ID_Photo_GEN|
| :--- | :---: | | :--- | :---: |
|Category|image generation| |Category|Image generation|
|Network|HRNet_W18| |Network|HRNet_W18|
|Dataset |-| |Dataset |-|
|Fine-tuning supported or not |No| |Fine-tuning supported or not |No|
...@@ -39,8 +39,8 @@ ...@@ -39,8 +39,8 @@
$ hub install ID_Photo_GEN $ hub install ID_Photo_GEN
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -77,12 +77,12 @@ ...@@ -77,12 +77,12 @@
- Prediction API, generating ID photos. - Prediction API, generating ID photos.
- **Parameter** - **Parameter**
* images (list[np.ndarray]): image data, ndarray.shape is in the format [H, W, C], BGR; * images (list[np.ndarray]): Image data, ndarray.shape is in the format [H, W, C], BGR.
* paths (list[str]): image path * paths (list[str]): Image path
* batch_size (int): batch size * batch_size (int): Batch size
* output_dir (str): save path of images, output by default. * output_dir (str): Save path of images, output by default.
* visualization (bool): Whether to save the recognition results as picture files; * visualization (bool): Whether to save the recognition results as picture files.
* use_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use_gpu (bool): Use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
**NOTE:** Choose one of `paths` and `images` to provide input data. **NOTE:** Choose one of `paths` and `images` to provide input data.
......
modules/image/Image_gan/style_transfer/UGATIT_83w/README_en.md
浏览文件 @ 4c07f02d
...@@ -40,8 +40,8 @@ ...@@ -40,8 +40,8 @@
$ hub install UGATIT_83w $ hub install UGATIT_83w
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -73,17 +73,17 @@ ...@@ -73,17 +73,17 @@
- Style transfer API, convert the input face image into anime style. - Style transfer API, convert the input face image into anime style.
- **Parameters** - **Parameters**
* images (list\[numpy.ndarray\]): image data, ndarray.shape is in the format [H, W, C], BGR; * images (list\[numpy.ndarray\]): Image data, ndarray.shape is in the format [H, W, C], BGR.
* paths (list\[str\]): image path，default is None； * paths (list\[str\]): image path，default is None；
* batch\_size (int): batch size, default is 1； * batch\_size (int): Batch size, default is 1；
* visualization (bool): Whether to save the recognition results as picture files, default is False; * visualization (bool): Whether to save the recognition results as picture files, default is False.
* output\_dir (str): save path of images, `output` by default. * output\_dir (str): Save path of images, `output` by default.
**NOTE:** Choose one of `paths` and `images` to provide data. **NOTE:** Choose one of `paths` and `images` to provide data.
- **Return** - **Return**
- res (list\[numpy.ndarray\]): result, ndarray.shape is in the format [H, W, C]. - res (list\[numpy.ndarray\]): Result, ndarray.shape is in the format [H, W, C].
## IV. Server Deployment ## IV. Server Deployment
......
modules/image/Image_gan/style_transfer/UGATIT_92w/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name|UGATIT_92w| |Module Name|UGATIT_92w|
| :--- | :---: | | :--- | :---: |
|Category|image editing| |Category|Image editing|
|Network |U-GAT-IT| |Network |U-GAT-IT|
|Dataset|selfie2anime| |Dataset|selfie2anime|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -40,8 +40,8 @@ ...@@ -40,8 +40,8 @@
$ hub install UGATIT_92w $ hub install UGATIT_92w
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -73,17 +73,17 @@ ...@@ -73,17 +73,17 @@
- Style transfer API, convert the input face image into anime style. - Style transfer API, convert the input face image into anime style.
- **Parameters** - **Parameters**
* images (list\[numpy.ndarray\]): image data, ndarray.shape is in the format [H, W, C], BGR; * images (list\[numpy.ndarray\]): Image data, ndarray.shape is in the format [H, W, C], BGR.
* paths (list\[str\]): image path，default is None； * paths (list\[str\]): Image path，default is None；
* batch\_size (int): batch size, default is 1； * batch\_size (int): Batch size, default is 1；
* visualization (bool): Whether to save the recognition results as picture files, default is False; * visualization (bool): Whether to save the recognition results as picture files, default is False.
* output\_dir (str): save path of images, `output` by default. * output\_dir (str): save path of images, `output` by default.
**NOTE:** Choose one of `paths` and `images` to provide input data. **NOTE:** Choose one of `paths` and `images` to provide input data.
- **Return** - **Return**
- res (list\[numpy.ndarray\]): result, ndarray.shape is in the format [H, W, C]. - res (list\[numpy.ndarray\]): Style tranfer result, ndarray.shape is in the format [H, W, C].
## IV. Server Deployment ## IV. Server Deployment
......
modules/image/Image_gan/style_transfer/animegan_v2_paprika_54/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name |animegan_v2_paprika_54| |Module Name |animegan_v2_paprika_54|
| :--- | :---: | | :--- | :---: |
|Category |image generation| |Category |Image generation|
|Network|AnimeGAN| |Network|AnimeGAN|
|Dataset|Paprika| |Dataset|Paprika|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -19,11 +19,11 @@ ...@@ -19,11 +19,11 @@
<p align="center"> <p align="center">
<img src="https://ai-studio-static-online.cdn.bcebos.com/bd002c4bb6a7427daf26988770bb18648b7d8d2bfd6746bfb9a429db4867727f" width = "450" height = "300" hspace='10'/> <img src="https://ai-studio-static-online.cdn.bcebos.com/bd002c4bb6a7427daf26988770bb18648b7d8d2bfd6746bfb9a429db4867727f" width = "450" height = "300" hspace='10'/>
<br /> <br />
输入图像 Input image
<br /> <br />
<img src="https://ai-studio-static-online.cdn.bcebos.com/6574669d87b24bab9627c6e33896528b4a0bf5af1cd84ca29655d68719f2d551" width = "450" height = "300" hspace='10'/> <img src="https://ai-studio-static-online.cdn.bcebos.com/6574669d87b24bab9627c6e33896528b4a0bf5af1cd84ca29655d68719f2d551" width = "450" height = "300" hspace='10'/>
<br /> <br />
输出图像 Output image
<br /> <br />
</p> </p>
...@@ -40,7 +40,7 @@ ...@@ -40,7 +40,7 @@
- paddlepaddle >= 1.8.0 - paddlepaddle >= 1.8.0
- paddlehub >= 1.8.0 | [How to install PaddleHub](../../../../docs/docs_ch/get_start/installation.rst) - paddlehub >= 1.8.0 | [How to install PaddleHub](../../../../docs/docs_en/get_start/installation.rst)
- ### 2、Installation - ### 2、Installation
...@@ -48,8 +48,8 @@ ...@@ -48,8 +48,8 @@
$ hub install animegan_v2_paprika_54 $ hub install animegan_v2_paprika_54
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -81,12 +81,12 @@ ...@@ -81,12 +81,12 @@
- **Parameters** - **Parameters**
- images (list\[numpy.ndarray\]): image data, ndarray.shape is in the format [H, W, C], BGR; - images (list\[numpy.ndarray\]): Image data, ndarray.shape is in the format [H, W, C], BGR.
- paths (list\[str\]): image path; - paths (list\[str\]): Image path.
- output\_dir (str): save path of images, `output` by default; - output\_dir (str): Save path of images, `output` by default.
- visualization (bool): Whether to save the results as picture files; - visualization (bool): Whether to save the results as picture files.
- min\_size (int): minimum size, default is 32; - min\_size (int): Minimum size, default is 32.
- max\_size (int): maximum size, default is 1024. - max\_size (int): Maximum size, default is 1024.
**NOTE:** Choose one of `paths` and `images` to provide input data. **NOTE:** Choose one of `paths` and `images` to provide input data.
......
modules/image/Image_gan/style_transfer/animegan_v2_paprika_97/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name |animegan_v2_paprika_97| |Module Name |animegan_v2_paprika_97|
| :--- | :---: | | :--- | :---: |
|Category |image generation| |Category |Image generation|
|Network|AnimeGAN| |Network|AnimeGAN|
|Dataset|Paprika| |Dataset|Paprika|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -48,8 +48,8 @@ ...@@ -48,8 +48,8 @@
$ hub install animegan_v2_paprika_97 $ hub install animegan_v2_paprika_97
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -81,12 +81,12 @@ ...@@ -81,12 +81,12 @@
- **Parameters** - **Parameters**
- images (list\[numpy.ndarray\]): image data, ndarray.shape is in the format [H, W, C], BGR; - images (list\[numpy.ndarray\]): Image data, ndarray.shape is in the format [H, W, C], BGR.
- paths (list\[str\]): image path; - paths (list\[str\]): Image path.
- output\_dir (str): save path of images, `output` by default; - output\_dir (str): Save path of images, `output` by default.
- visualization (bool): Whether to save the results as picture files; - visualization (bool): Whether to save the results as picture files.
- min\_size (int): minimum size, default is 32; - min\_size (int): Minimum size, default is 32.
- max\_size (int): maximum size, default is 1024. - max\_size (int): Maximum size, default is 1024.
**NOTE:** Choose one of `paths` and `images` to provide input data. **NOTE:** Choose one of `paths` and `images` to provide input data.
......
modules/image/Image_gan/style_transfer/msgnet/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name|msgnet| |Module Name|msgnet|
| :--- | :---: | | :--- | :---: |
|Category|image editing| |Category|Image editing|
|Network|msgnet| |Network|msgnet|
|Dataset|COCO2014| |Dataset|COCO2014|
|Fine-tuning supported or not|Yes| |Fine-tuning supported or not|Yes|
...@@ -38,30 +38,30 @@ ...@@ -38,30 +38,30 @@
$ hub install msgnet $ hub install msgnet
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
- ### 1、Command line Prediction - ### 1、Command line Prediction
``` - ```
$ hub run msgnet --input_path "/PATH/TO/ORIGIN/IMAGE" --style_path "/PATH/TO/STYLE/IMAGE" $ hub run msgnet --input_path "/PATH/TO/ORIGIN/IMAGE" --style_path "/PATH/TO/STYLE/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
```python - ```python
import paddle import paddle
import paddlehub as hub import paddlehub as hub
if __name__ == '__main__': if __name__ == '__main__':
model = hub.Module(name='msgnet') model = hub.Module(name='msgnet')
result = model.predict(origin=["/PATH/TO/ORIGIN/IMAGE"], style="/PATH/TO/STYLE/IMAGE", visualization=True, save_path ="/PATH/TO/SAVE/IMAGE") result = model.predict(origin=["/PATH/TO/ORIGIN/IMAGE"], style="/PATH/TO/STYLE/IMAGE", visualization=True, save_path ="/PATH/TO/SAVE/IMAGE")
``` ```
- ### 3.Fine-tune and Encapsulation - ### 3.Fine-tune and Encapsulation
...@@ -111,7 +111,7 @@ if __name__ == '__main__': ...@@ -111,7 +111,7 @@ if __name__ == '__main__':
- Model prediction - Model prediction
- When Fine-tune is completed, the model with the best performance on the verification set will be saved in the `${CHECKPOINT_DIR}/best_model` directory. We use this model to make predictions. The `predict.py` script is as follows: - When Fine-tune is completed, the model with the best performance on the verification set will be saved in the `${CHECKPOINT_DIR}/best_model` directory. We use this model to make predictions. The `predict.py` script is as follows:
```python - ```python
import paddle import paddle
import paddlehub as hub import paddlehub as hub
...@@ -120,10 +120,10 @@ if __name__ == '__main__': ...@@ -120,10 +120,10 @@ if __name__ == '__main__':
result = model.predict(origin=["/PATH/TO/ORIGIN/IMAGE"], style="/PATH/TO/STYLE/IMAGE", visualization=True, save_path ="/PATH/TO/SAVE/IMAGE") result = model.predict(origin=["/PATH/TO/ORIGIN/IMAGE"], style="/PATH/TO/STYLE/IMAGE", visualization=True, save_path ="/PATH/TO/SAVE/IMAGE")
``` ```
- **Args** - **Parameters**
* `origin`: Image path or ndarray data with format [H, W, C], BGR; * `origin`: Image path or ndarray data with format [H, W, C], BGR.
* `style`: Style image path; * `style`: Style image path.
* `visualization`: Whether to save the recognition results as picture files; * `visualization`: Whether to save the recognition results as picture files.
* `save_path`: Save path of the result, default is 'style_tranfer'. * `save_path`: Save path of the result, default is 'style_tranfer'.
...@@ -148,7 +148,7 @@ if __name__ == '__main__': ...@@ -148,7 +148,7 @@ if __name__ == '__main__':
- With a configured server, use the following lines of code to send the prediction request and obtain the result: - With a configured server, use the following lines of code to send the prediction request and obtain the result:
```python - ```python
import requests import requests
import json import json
import cv2 import cv2
......
modules/image/classification/resnet50_vd_animals/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name|resnet50_vd_animals| |Module Name|resnet50_vd_animals|
| :--- | :---: | | :--- | :---: |
|Category |image classification| |Category |Image classification|
|Network|ResNet50_vd| |Network|ResNet50_vd|
|Dataset|Baidu self-built dataset| |Dataset|Baidu self-built dataset|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -33,8 +33,8 @@ ...@@ -33,8 +33,8 @@
- ```shell - ```shell
$ hub install resnet50_vd_animals $ hub install resnet50_vd_animals
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -44,7 +44,7 @@ ...@@ -44,7 +44,7 @@
- ```shell - ```shell
$ hub run resnet50_vd_animals --input_path "/PATH/TO/IMAGE" $ hub run resnet50_vd_animals --input_path "/PATH/TO/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_ch/tutorial/cmd_usage.rst) - If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
...@@ -142,7 +142,7 @@ ...@@ -142,7 +142,7 @@
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
```python - ```python
import requests import requests
import json import json
import cv2 import cv2
......
modules/image/classification/resnet50_vd_imagenet_ssld/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name|resnet50_vd_imagenet_ssld| |Module Name|resnet50_vd_imagenet_ssld|
| :--- | :---: | | :--- | :---: |
|Category |image classification| |Category |Image classification|
|Network|ResNet_vd| |Network|ResNet_vd|
|Dataset|ImageNet-2012| |Dataset|ImageNet-2012|
|Fine-tuning supported or notFine-tuning|Yes| |Fine-tuning supported or notFine-tuning|Yes|
...@@ -32,8 +32,8 @@ ...@@ -32,8 +32,8 @@
$ hub install resnet50_vd_imagenet_ssld $ hub install resnet50_vd_imagenet_ssld
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -69,7 +69,7 @@ ...@@ -69,7 +69,7 @@
to_rgb=True) to_rgb=True)
``` ```
- `transforms` The data enhancement module defines lots of data preprocessing methods. Users can replace the data preprocessing methods according to their needs. - `transforms`: The data enhancement module defines lots of data preprocessing methods. Users can replace the data preprocessing methods according to their needs.
- Step2: Download the dataset - Step2: Download the dataset
...@@ -108,20 +108,20 @@ ...@@ -108,20 +108,20 @@
- `Trainer` mainly control the training of Fine-tune, including the following controllable parameters: - `Trainer` mainly control the training of Fine-tune, including the following controllable parameters:
* `model`: Optimized model; * `model`: Optimized model.
* `optimizer`: Optimizer selection; * `optimizer`: Optimizer selection.
* `use_vdl`: Whether to use vdl to visualize the training process; * `use_vdl`: Whether to use vdl to visualize the training process.
* `checkpoint_dir`: The storage address of the model parameters; * `checkpoint_dir`: The storage address of the model parameters.
* `compare_metrics`: The measurement index of the optimal model; * `compare_metrics`: The measurement index of the optimal model.
- `trainer.train` mainly control the specific training process, including the following controllable parameters: - `trainer.train` mainly control the specific training process, including the following controllable parameters:
* `train_dataset`: Training dataset; * `train_dataset`: Training dataset.
* `epochs`: Epochs of training process; * `epochs`: Epochs of training process.
* `batch_size`: Batch size; * `batch_size`: Batch size.
* `num_workers`: Number of workers. * `num_workers`: Number of workers.
* `eval_dataset`: Validation dataset; * `eval_dataset`: Validation dataset.
* `log_interval`:The interval for printing logs; * `log_interval`:The interval for printing logs.
* `save_interval`: The interval for saving model parameters. * `save_interval`: The interval for saving model parameters.
...@@ -159,7 +159,7 @@ ...@@ -159,7 +159,7 @@
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
```python - ```python
import requests import requests
import json import json
import cv2 import cv2
...@@ -195,4 +195,4 @@ ...@@ -195,4 +195,4 @@
* 1.1.0 * 1.1.0
Upgrade to dynamic version. Upgrade to dynamic version
modules/image/classification/resnet_v2_50_imagenet/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name|resnet_v2_50_imagenet| |Module Name|resnet_v2_50_imagenet|
| :--- | :---: | | :--- | :---: |
|Category |image classification| |Category |Image classification|
|Network|ResNet V2| |Network|ResNet V2|
|Dataset|ImageNet-2012| |Dataset|ImageNet-2012|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -23,7 +23,7 @@ ...@@ -23,7 +23,7 @@
- paddlepaddle >= 1.4.0 - paddlepaddle >= 1.4.0
- paddlehub >= 1.0.0 | [How to install PaddleHub](../../../../docs/docs_ch/get_start/installation.rst) - paddlehub >= 1.0.0 | [How to install PaddleHub](../../../../docs/docs_en/get_start/installation.rst)
- ### 2、Installation - ### 2、Installation
...@@ -31,8 +31,8 @@ ...@@ -31,8 +31,8 @@
- ```shell - ```shell
$ hub install resnet_v2_50_imagenet $ hub install resnet_v2_50_imagenet
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -64,10 +64,10 @@ ...@@ -64,10 +64,10 @@
- Prediction API for classification. - Prediction API for classification.
- **Parameter** - **Parameter**
- data (dict): key is 'image'，value is the list of image path. - data (dict): Key is 'image'，value is the list of image path.
- **Return** - **Return**
- result (list[dict]): the list of classification results，key is the prediction label, value is the corresponding confidence. - result (list[dict]): The list of classification results，key is the prediction label, value is the corresponding confidence.
...@@ -79,6 +79,7 @@ ...@@ -79,6 +79,7 @@
First release First release
- 1.0.1 - 1.0.1
Fix encoding problem in python2 Fix encoding problem in python2
- ```shell - ```shell
......
modules/image/semantic_segmentation/Pneumonia_CT_LKM_PP/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name|Pneumonia_CT_LKM_PP| |Module Name|Pneumonia_CT_LKM_PP|
| :--- | :---: | | :--- | :---: |
|Category|image segmentation| |Category|Image segmentation|
|Network |-| |Network |-|
|Dataset|-| |Dataset|-|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -32,8 +32,8 @@ ...@@ -32,8 +32,8 @@
$ hub install Pneumonia_CT_LKM_PP==1.0.0 $ hub install Pneumonia_CT_LKM_PP==1.0.0
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -64,7 +64,7 @@ ...@@ -64,7 +64,7 @@
- ### 2、API - ### 2、API
```python - ```python
def segmentation(data) def segmentation(data)
``` ```
...@@ -78,9 +78,9 @@ ...@@ -78,9 +78,9 @@
- **Return** - **Return**
* result (list\[dict\]): the list of recognition results, where each element is dict and each field is: * result (list\[dict\]): the list of recognition results, where each element is dict and each field is:
* input_lesion_np_path: input path of lesion; * input_lesion_np_path: input path of lesion.
* output_lesion_np: segmentation result path of lesion; * output_lesion_np: segmentation result path of lesion.
* input_lung_np_path: input path of lung; * input_lung_np_path: input path of lung.
* output_lung_np：segmentation result path of lung. * output_lung_np：segmentation result path of lung.
......
modules/image/semantic_segmentation/Pneumonia_CT_LKM_PP_lung/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name|Pneumonia_CT_LKM_PP_lung| |Module Name|Pneumonia_CT_LKM_PP_lung|
| :--- | :---: | | :--- | :---: |
|Category|image segmentation| |Category|Image segmentation|
|Network |-| |Network |-|
|Dataset|-| |Dataset|-|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -64,7 +64,7 @@ ...@@ -64,7 +64,7 @@
- ### 2、API - ### 2、API
```python - ```python
def segmentation(data) def segmentation(data)
``` ```
...@@ -72,16 +72,16 @@ ...@@ -72,16 +72,16 @@
- **Parameter** - **Parameter**
* data (dict): key is "image_np_path", value is the list of results which contains lesion and lung segmentation masks. * data (dict): Key is "image_np_path", value is the list of results which contains lesion and lung segmentation masks.
- **Return** - **Return**
* result (list\[dict\]): the list of recognition results, where each element is dict and each field is: * result (list\[dict\]): The list of recognition results, where each element is dict and each field is:
* input_lesion_np_path: input path of lesion; * input_lesion_np_path: Input path of lesion.
* output_lesion_np: segmentation result path of lesion; * output_lesion_np: Segmentation result path of lesion.
* input_lung_np_path: input path of lung; * input_lung_np_path: Input path of lung.
* output_lung_np：segmentation result path of lung. * output_lung_np: Segmentation result path of lung.
## IV. Release Note ## IV. Release Note
......
modules/image/semantic_segmentation/U2Net/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name |U2Net| |Module Name |U2Net|
| :--- | :---: | | :--- | :---: |
|Category |image segmentation| |Category |Image segmentation|
|Network |U^2Net| |Network |U^2Net|
|Dataset|-| |Dataset|-|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -44,8 +44,8 @@ ...@@ -44,8 +44,8 @@
$ hub install U2Net $ hub install U2Net
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -79,12 +79,12 @@ ...@@ -79,12 +79,12 @@
- Prediction API, obtaining segmentation result. - Prediction API, obtaining segmentation result.
- **Parameter** - **Parameter**
* images (list[np.ndarray]) : image data, ndarray.shape is in the format [H, W, C], BGR; * images (list[np.ndarray]) : Image data, ndarray.shape is in the format [H, W, C], BGR.
* paths (list[str]) : image path; * paths (list[str]) : Image path.
* batch_size (int) : batch size; * batch_size (int) : Batch size.
* input_size (int) : input image size, default is 320; * input_size (int) : Input image size, default is 320.
* output_dir (str) : save path of images, 'output' by default; * output_dir (str) : Save path of images, 'output' by default.
* visualization (bool) : whether to save the results as picture files. * visualization (bool) : Whether to save the results as picture files.
- **Return** - **Return**
* results (list[np.ndarray]): The list of segmentation results. * results (list[np.ndarray]): The list of segmentation results.
......
modules/image/semantic_segmentation/U2Netp/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name |U2Netp| |Module Name |U2Netp|
| :--- | :---: | | :--- | :---: |
|Category |image segmentation| |Category |Image segmentation|
|Network |U^2Net| |Network |U^2Net|
|Dataset|-| |Dataset|-|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -44,8 +44,8 @@ ...@@ -44,8 +44,8 @@
$ hub install U2Netp $ hub install U2Netp
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -79,15 +79,15 @@ ...@@ -79,15 +79,15 @@
- Prediction API, obtaining segmentation result. - Prediction API, obtaining segmentation result.
- **Parameter** - **Parameter**
* images (list[np.ndarray]) : image data, ndarray.shape is in the format [H, W, C], BGR; * images (list[np.ndarray]) : Image data, ndarray.shape is in the format [H, W, C], BGR.
* paths (list[str]) : image path; * paths (list[str]) : Image path.
* batch_size (int) : batch size; * batch_size (int) : Batch size.
* input_size (int) : input image size, default is 320; * input_size (int) : Input image size, default is 320.
* output_dir (str) : save path of images, 'output' by default; * output_dir (str) : Save path of images, 'output' by default.
* visualization (bool) : whether to save the results as picture files. * visualization (bool) : Whether to save the results as picture files.
- **Return** - **Return**
* results (list[np.ndarray]): the list of segmentation results. * results (list[np.ndarray]): The list of segmentation results.
## IV. Release Note ## IV. Release Note
......
modules/image/semantic_segmentation/ace2p/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name|ace2p| |Module Name|ace2p|
| :--- | :---: | | :--- | :---: |
|Category|image segmentation| |Category|Image segmentation|
|Network|ACE2P| |Network|ACE2P|
|Dataset|LIP| |Dataset|LIP|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -50,21 +50,24 @@ ...@@ -50,21 +50,24 @@
- ```shell - ```shell
$ hub install ace2p $ hub install ace2p
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
- ### 1、Command line Prediction - ### 1、Command line Prediction
```shell - ```shell
$ hub run ace2p --input_path "/PATH/TO/IMAGE" $ hub run ace2p --input_path "/PATH/TO/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
```python - ```python
import paddlehub as hub import paddlehub as hub
import cv2 import cv2
...@@ -72,9 +75,9 @@ ...@@ -72,9 +75,9 @@
result = human_parser.segmentation(images=[cv2.imread('/PATH/TO/IMAGE')]) result = human_parser.segmentation(images=[cv2.imread('/PATH/TO/IMAGE')])
``` ```
- ### 3、API - ### 3、API
```python - ```python
def segmentation(images=None, def segmentation(images=None,
paths=None, paths=None,
batch_size=1, batch_size=1,
...@@ -87,21 +90,21 @@ ...@@ -87,21 +90,21 @@
- **Parameter** - **Parameter**
* images (list\[numpy.ndarray\]): image data, ndarray.shape is in the format [H, W, C], BGR; * images (list\[numpy.ndarray\]): Image data, ndarray.shape is in the format [H, W, C], BGR.
* paths (list\[str\]): image path; * paths (list\[str\]): Image path.
* batch\_size (int): batch size; * batch\_size (int): Batch size.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use\_gpu (bool): Use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
* output\_dir (str): save path of output, default is 'ace2p_output'; * output\_dir (str): Save path of output, default is 'ace2p_output'.
* visualization (bool): Whether to save the recognition results as picture files. * visualization (bool): Whether to save the recognition results as picture files.
- **Return** - **Return**
* res (list\[dict\]): The list of recognition results, where each element is dict and each field is: * res (list\[dict\]): The list of recognition results, where each element is dict and each field is:
* save\_path (str, optional): Save path of the result; * save\_path (str, optional): Save path of the result.
* data (numpy.ndarray): The result of portrait segmentation. * data (numpy.ndarray): The result of portrait segmentation.
```python - ```python
def save_inference_model(dirname, def save_inference_model(dirname,
model_filename=None, model_filename=None,
params_filename=None, params_filename=None,
...@@ -112,8 +115,8 @@ ...@@ -112,8 +115,8 @@
- **Parameters** - **Parameters**
* dirname: Save path. * dirname: Save path.
* model\_filename: model file name，defalt is \_\_model\_\_ * model\_filename: mMdel file name，defalt is \_\_model\_\_
* params\_filename: parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True) * params\_filename: Parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True)
* combined: Whether to save the parameters to a unified file. * combined: Whether to save the parameters to a unified file.
...@@ -125,7 +128,7 @@ ...@@ -125,7 +128,7 @@
- Run the startup command: - Run the startup command:
```shell - ```shell
$ hub serving start -m ace2p $ hub serving start -m ace2p
``` ```
...@@ -138,7 +141,7 @@ ...@@ -138,7 +141,7 @@
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
```python - ```python
import requests import requests
import json import json
import cv2 import cv2
......
modules/image/semantic_segmentation/deeplabv3p_xception65_humanseg/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name |deeplabv3p_xception65_humanseg| |Module Name |deeplabv3p_xception65_humanseg|
| :--- | :---: | | :--- | :---: |
|Category|image segmentation| |Category|Image segmentation|
|Network|deeplabv3p| |Network|deeplabv3p|
|Dataset|Baidu self-built dataset| |Dataset|Baidu self-built dataset|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -41,34 +41,34 @@ ...@@ -41,34 +41,34 @@
- ```shell - ```shell
$ hub install deeplabv3p_xception65_humanseg $ hub install deeplabv3p_xception65_humanseg
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
- ### 1、Command line Prediction - ### 1、Command line Prediction
```shell - ```shell
hub run deeplabv3p_xception65_humanseg --input_path "/PATH/TO/IMAGE" hub run deeplabv3p_xception65_humanseg --input_path "/PATH/TO/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
```python - ```python
import paddlehub as hub import paddlehub as hub
import cv2 import cv2
human_seg = hub.Module(name="deeplabv3p_xception65_humanseg") human_seg = hub.Module(name="deeplabv3p_xception65_humanseg")
result = human_seg.segmentation(images=[cv2.imread('/PATH/TO/IMAGE')]) result = human_seg.segmentation(images=[cv2.imread('/PATH/TO/IMAGE')])
``` ```
- ### 3.API - ### 3.API
```python - ```python
def segmentation(images=None, def segmentation(images=None,
paths=None, paths=None,
batch_size=1, batch_size=1,
...@@ -80,20 +80,20 @@ ...@@ -80,20 +80,20 @@
- Prediction API, generating segmentation result. - Prediction API, generating segmentation result.
- **Parameter** - **Parameter**
* images (list\[numpy.ndarray\]): image data, ndarray.shape is in the format [H, W, C], BGR; * images (list\[numpy.ndarray\]): Image data, ndarray.shape is in the format [H, W, C], BGR.
* paths (list\[str\]): image path; * paths (list\[str\]): Image path.
* batch\_size (int): batch size; * batch\_size (int): Batch size.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use\_gpu (bool): Use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
* visualization (bool): Whether to save the recognition results as picture files; * visualization (bool): Whether to save the recognition results as picture files.
* output\_dir (str): save path of images. * output\_dir (str): Save path of images.
- **Return** - **Return**
* res (list\[dict\]): The list of recognition results, where each element is dict and each field is: * res (list\[dict\]): The list of recognition results, where each element is dict and each field is:
* save\_path (str, optional): Save path of the result; * save\_path (str, optional): Save path of the result.
* data (numpy.ndarray): The result of portrait segmentation. * data (numpy.ndarray): The result of portrait segmentation.
```python - ```python
def save_inference_model(dirname, def save_inference_model(dirname,
model_filename=None, model_filename=None,
params_filename=None, params_filename=None,
...@@ -104,8 +104,8 @@ ...@@ -104,8 +104,8 @@
- **Parameters** - **Parameters**
* dirname: Save path. * dirname: Save path.
* model\_filename: model file name，defalt is \_\_model\_\_ * model\_filename: Model file name，defalt is \_\_model\_\_
* params\_filename: parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True) * params\_filename: Parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True)
* combined: Whether to save the parameters to a unified file. * combined: Whether to save the parameters to a unified file.
...@@ -128,7 +128,7 @@ ...@@ -128,7 +128,7 @@
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
```python - ```python
import requests import requests
import json import json
import cv2 import cv2
......
modules/image/semantic_segmentation/humanseg_lite/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name |humanseg_lite| |Module Name |humanseg_lite|
| :--- | :---: | | :--- | :---: |
|Category |image segmentation| |Category |Image segmentation|
|Network|shufflenet| |Network|shufflenet|
|Dataset|Baidu self-built dataset| |Dataset|Baidu self-built dataset|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -40,20 +40,23 @@ ...@@ -40,20 +40,23 @@
$ hub install humanseg_lite $ hub install humanseg_lite
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
- ### 1、Command line Prediction - ### 1、Command line Prediction
``` - ```
hub run humanseg_lite --input_path "/PATH/TO/IMAGE" hub run humanseg_lite --input_path "/PATH/TO/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
- Image segmentation and video segmentation example： - Image segmentation and video segmentation example：
```python - ```python
import cv2 import cv2
import paddlehub as hub import paddlehub as hub
...@@ -67,7 +70,7 @@ ...@@ -67,7 +70,7 @@
``` ```
- Video prediction example: - Video prediction example:
```python - ```python
import cv2 import cv2
import numpy as np import numpy as np
import paddlehub as hub import paddlehub as hub
...@@ -99,7 +102,7 @@ ...@@ -99,7 +102,7 @@
- ### 3、API - ### 3、API
```python - ```python
def segment(images=None, def segment(images=None,
paths=None, paths=None,
batch_size=1, batch_size=1,
...@@ -112,20 +115,20 @@ ...@@ -112,20 +115,20 @@
- **Parameter** - **Parameter**
* images (list\[numpy.ndarray\]): image data, ndarray.shape is in the format [H, W, C], BGR; * images (list\[numpy.ndarray\]): image data, ndarray.shape is in the format [H, W, C], BGR.
* paths (list\[str\]): image path; * paths (list\[str\]): image path.
* batch\_size (int): batch size; * batch\_size (int): batch size.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use\_gpu (bool): use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
* visualization (bool): Whether to save the results as picture files; * visualization (bool): Whether to save the results as picture files.
* output\_dir (str): save path of images, humanseg_lite_output by default. * output\_dir (str): save path of images, humanseg_lite_output by default.
- **Return** - **Return**
* res (list\[dict\]): The list of recognition results, where each element is dict and each field is: * res (list\[dict\]): The list of recognition results, where each element is dict and each field is:
* save\_path (str, optional): Save path of the result; * save\_path (str, optional): Save path of the result.
* data (numpy.ndarray): The result of portrait segmentation. * data (numpy.ndarray): The result of portrait segmentation.
```python - ```python
def video_stream_segment(self, def video_stream_segment(self,
frame_org, frame_org,
frame_id, frame_id,
...@@ -133,26 +136,25 @@ ...@@ -133,26 +136,25 @@
prev_cfd, prev_cfd,
use_gpu=False): use_gpu=False):
``` ```
- Prediction API, used to segment video portraits frame by frame. - Prediction API, used to segment video portraits frame by frame.
- **Parameter** - **Parameter**
* frame_org (numpy.ndarray): single frame for prediction，ndarray.shape is in the format [H, W, C], BGR; * frame_org (numpy.ndarray): single frame for prediction，ndarray.shape is in the format [H, W, C], BGR.
* frame_id (int): The number of the current frame; * frame_id (int): The number of the current frame.
* prev_gray (numpy.ndarray): Grayscale image of the previous network input; * prev_gray (numpy.ndarray): Grayscale image of the previous network input.
* prev_cfd (numpy.ndarray): The fusion image from optical flow and the prediction result from previous frame. * prev_cfd (numpy.ndarray): The fusion image from optical flow and the prediction result from previous frame.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use\_gpu (bool): use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
- **Return** - **Return**
* img_matting (numpy.ndarray): The result of portrait segmentation; * img_matting (numpy.ndarray): The result of portrait segmentation.
* cur_gray (numpy.ndarray): Grayscale image of the current network input; * cur_gray (numpy.ndarray): Grayscale image of the current network input.
* optflow_map (numpy.ndarray): The fusion image from optical flow and the prediction result from current frame. * optflow_map (numpy.ndarray): The fusion image from optical flow and the prediction result from current frame.
```python - ```python
def video_segment(self, def video_segment(self,
video_path=None, video_path=None,
use_gpu=False, use_gpu=False,
...@@ -164,11 +166,11 @@ ...@@ -164,11 +166,11 @@
- **Parameter** - **Parameter**
* video\_path (str): Video path for segmentation。If None, the video will be obtained from the local camera, and a window will display the online segmentation result. * video\_path (str): Video path for segmentation。If None, the video will be obtained from the local camera, and a window will display the online segmentation result.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use\_gpu (bool): use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
* save\_dir (str): save path of video. * save\_dir (str): save path of video.
```python - ```python
def save_inference_model(dirname='humanseg_lite_model', def save_inference_model(dirname='humanseg_lite_model',
model_filename=None, model_filename=None,
params_filename=None, params_filename=None,
...@@ -195,8 +197,8 @@ ...@@ -195,8 +197,8 @@
- Run the startup command: - Run the startup command:
```shell - ```shell
$ hub serving start -m humanseg_lite hub serving start -m humanseg_lite
``` ```
- The servitization API is now deployed and the default port number is 8866. - The servitization API is now deployed and the default port number is 8866.
...@@ -207,7 +209,7 @@ ...@@ -207,7 +209,7 @@
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
```python - ```python
import requests import requests
import json import json
import base64 import base64
...@@ -245,7 +247,7 @@ ...@@ -245,7 +247,7 @@
- 1.1.0 - 1.1.0
Added video portrait split interface Added video portrait segmentation interface
Added video stream portrait segmentation interface Added video stream portrait segmentation interface
* 1.1.1 * 1.1.1
......
modules/image/semantic_segmentation/humanseg_mobile/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name |humanseg_mobile| |Module Name |humanseg_mobile|
| :--- | :---: | | :--- | :---: |
|Category |image segmentation| |Category |Image segmentation|
|Network|hrnet| |Network|hrnet|
|Dataset|Baidu self-built dataset| |Dataset|Baidu self-built dataset|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -40,17 +40,20 @@ ...@@ -40,17 +40,20 @@
$ hub install humanseg_mobile $ hub install humanseg_mobile
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
- ### 1、Command line Prediction - ### 1、Command line Prediction
``` - ```
hub run humanseg_mobile --input_path "/PATH/TO/IMAGE" hub run humanseg_mobile --input_path "/PATH/TO/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
- Image segmentation and video segmentation example： - Image segmentation and video segmentation example：
```python ```python
...@@ -112,17 +115,17 @@ ...@@ -112,17 +115,17 @@
- **Parameter** - **Parameter**
* images (list\[numpy.ndarray\]): image data, ndarray.shape is in the format [H, W, C], BGR; * images (list\[numpy.ndarray\]): image data, ndarray.shape is in the format [H, W, C], BGR.
* paths (list\[str\]): image path; * paths (list\[str\]): image path.
* batch\_size (int): batch size; * batch\_size (int): batch size.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use\_gpu (bool): use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
* visualization (bool): Whether to save the results as picture files; * visualization (bool): Whether to save the results as picture files.
* output\_dir (str): save path of images, humanseg_mobile_output by default. * output\_dir (str): save path of images, humanseg_mobile_output by default.
- **Return** - **Return**
* res (list\[dict\]): The list of recognition results, where each element is dict and each field is: * res (list\[dict\]): The list of recognition results, where each element is dict and each field is:
* save\_path (str, optional): Save path of the result; * save\_path (str, optional): Save path of the result.
* data (numpy.ndarray): The result of portrait segmentation. * data (numpy.ndarray): The result of portrait segmentation.
```python ```python
...@@ -138,17 +141,17 @@ ...@@ -138,17 +141,17 @@
- **Parameter** - **Parameter**
* frame_org (numpy.ndarray): single frame for prediction，ndarray.shape is in the format [H, W, C], BGR; * frame_org (numpy.ndarray): single frame for prediction，ndarray.shape is in the format [H, W, C], BGR.
* frame_id (int): The number of the current frame; * frame_id (int): The number of the current frame.
* prev_gray (numpy.ndarray): Grayscale image of the previous network input; * prev_gray (numpy.ndarray): Grayscale image of the previous network input.
* prev_cfd (numpy.ndarray): The fusion image from optical flow and the prediction result from previous frame. * prev_cfd (numpy.ndarray): The fusion image from optical flow and the prediction result from previous frame.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use\_gpu (bool): Use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
- **Return** - **Return**
* img_matting (numpy.ndarray): The result of portrait segmentation; * img_matting (numpy.ndarray): The result of portrait segmentation.
* cur_gray (numpy.ndarray): Grayscale image of the current network input; * cur_gray (numpy.ndarray): Grayscale image of the current network input.
* optflow_map (numpy.ndarray): The fusion image from optical flow and the prediction result from current frame. * optflow_map (numpy.ndarray): The fusion image from optical flow and the prediction result from current frame.
...@@ -164,7 +167,7 @@ ...@@ -164,7 +167,7 @@
- **Parameter** - **Parameter**
* video\_path (str): Video path for segmentation。If None, the video will be obtained from the local camera, and a window will display the online segmentation result. * video\_path (str): Video path for segmentation。If None, the video will be obtained from the local camera, and a window will display the online segmentation result.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use\_gpu (bool): Use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
* save\_dir (str): save path of video. * save\_dir (str): save path of video.
...@@ -181,8 +184,8 @@ ...@@ -181,8 +184,8 @@
- **Parameters** - **Parameters**
* dirname: Save path. * dirname: Save path.
* model\_filename: model file name，defalt is \_\_model\_\_ * model\_filename: Model file name，defalt is \_\_model\_\_
* params\_filename: parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True) * params\_filename: Parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True)
* combined: Whether to save the parameters to a unified file. * combined: Whether to save the parameters to a unified file.
...@@ -195,7 +198,7 @@ ...@@ -195,7 +198,7 @@
- Run the startup command: - Run the startup command:
```shell - ```shell
$ hub serving start -m humanseg_mobile $ hub serving start -m humanseg_mobile
``` ```
......
modules/image/semantic_segmentation/humanseg_server/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name |humanseg_server| |Module Name |humanseg_server|
| :--- | :---: | | :--- | :---: |
|Category |image segmentation| |Category |Image segmentation|
|Network|hrnet| |Network|hrnet|
|Dataset|Baidu self-built dataset| |Dataset|Baidu self-built dataset|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -40,17 +40,18 @@ ...@@ -40,17 +40,18 @@
$ hub install humanseg_server $ hub install humanseg_server
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
- ### 1、Command line Prediction - ### 1、Command line Prediction
``` - ```
hub run humanseg_server --input_path "/PATH/TO/IMAGE" hub run humanseg_server --input_path "/PATH/TO/IMAGE"
``` ```
- If you want to call the Hub module through the command line, please refer to: [PaddleHub Command Line Instruction](../../../../docs/docs_en/tutorial/cmd_usage.rst)
- ### 2、Prediction Code Example - ### 2、Prediction Code Example
- Image segmentation and video segmentation example： - Image segmentation and video segmentation example：
```python ```python
...@@ -112,17 +113,17 @@ ...@@ -112,17 +113,17 @@
- **Parameter** - **Parameter**
* images (list\[numpy.ndarray\]): image data, ndarray.shape is in the format [H, W, C], BGR; * images (list\[numpy.ndarray\]): Image data, ndarray.shape is in the format [H, W, C], BGR.
* paths (list\[str\]): image path; * paths (list\[str\]): Image path.
* batch\_size (int): batch size; * batch\_size (int): Batch size.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use\_gpu (bool): Use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
* visualization (bool): Whether to save the results as picture files; * visualization (bool): Whether to save the results as picture files.
* output\_dir (str): save path of images, humanseg_server_output by default. * output\_dir (str): Save path of images, humanseg_server_output by default.
- **Return** - **Return**
* res (list\[dict\]): The list of recognition results, where each element is dict and each field is: * res (list\[dict\]): The list of recognition results, where each element is dict and each field is:
* save\_path (str, optional): Save path of the result; * save\_path (str, optional): Save path of the result.
* data (numpy.ndarray): The result of portrait segmentation. * data (numpy.ndarray): The result of portrait segmentation.
```python ```python
...@@ -138,17 +139,17 @@ ...@@ -138,17 +139,17 @@
- **Parameter** - **Parameter**
* frame_org (numpy.ndarray): single frame for prediction，ndarray.shape is in the format [H, W, C], BGR; * frame_org (numpy.ndarray): Single frame for prediction，ndarray.shape is in the format [H, W, C], BGR.
* frame_id (int): The number of the current frame; * frame_id (int): The number of the current frame.
* prev_gray (numpy.ndarray): Grayscale image of the previous network input; * prev_gray (numpy.ndarray): Grayscale image of the previous network input.
* prev_cfd (numpy.ndarray): The fusion image from optical flow and the prediction result from previous frame. * prev_cfd (numpy.ndarray): The fusion image from optical flow and the prediction result from previous frame.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use\_gpu (bool): Use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
- **Return** - **Return**
* img_matting (numpy.ndarray): The result of portrait segmentation; * img_matting (numpy.ndarray): The result of portrait segmentation.
* cur_gray (numpy.ndarray): Grayscale image of the current network input; * cur_gray (numpy.ndarray): Grayscale image of the current network input.
* optflow_map (numpy.ndarray): The fusion image from optical flow and the prediction result from current frame. * optflow_map (numpy.ndarray): The fusion image from optical flow and the prediction result from current frame.
...@@ -164,8 +165,8 @@ ...@@ -164,8 +165,8 @@
- **Parameter** - **Parameter**
* video\_path (str): Video path for segmentation。If None, the video will be obtained from the local camera, and a window will display the online segmentation result. * video\_path (str): Video path for segmentation。If None, the video will be obtained from the local camera, and a window will display the online segmentation result.
* use\_gpu (bool): use GPU or not; **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU** * use\_gpu (bool): Use GPU or not. **set the CUDA_VISIBLE_DEVICES environment variable first if you are using GPU**
* save\_dir (str): save path of video. * save\_dir (str): Save path of video.
```python ```python
...@@ -181,8 +182,8 @@ ...@@ -181,8 +182,8 @@
- **Parameters** - **Parameters**
* dirname: Save path. * dirname: Save path.
* model\_filename: model file name，defalt is \_\_model\_\_ * model\_filename: Model file name，defalt is \_\_model\_\_
* params\_filename: parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True) * params\_filename: Parameter file name，defalt is \_\_params\_\_(Only takes effect when `combined` is True)
* combined: Whether to save the parameters to a unified file. * combined: Whether to save the parameters to a unified file.
...@@ -195,7 +196,7 @@ ...@@ -195,7 +196,7 @@
- Run the startup command: - Run the startup command:
```shell - ```shell
$ hub serving start -m humanseg_server $ hub serving start -m humanseg_server
``` ```
...@@ -207,7 +208,7 @@ ...@@ -207,7 +208,7 @@
- With a configured server, use the following lines of code to send the prediction request and obtain the result - With a configured server, use the following lines of code to send the prediction request and obtain the result
```python - ```python
import requests import requests
import json import json
import base64 import base64
...@@ -245,7 +246,7 @@ ...@@ -245,7 +246,7 @@
- 1.1.0 - 1.1.0
Added video portrait split interface Added video portrait segmentation interface
Added video stream portrait segmentation interface Added video stream portrait segmentation interface
......
modules/video/Video_editing/SkyAR/README_en.md
浏览文件 @ 4c07f02d
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
|Module Name|SkyAR| |Module Name|SkyAR|
| :--- | :---: | | :--- | :---: |
|Category|video editing| |Category|Video editing|
|Network|UNet| |Network|UNet|
|Dataset|-| |Dataset|-|
|Fine-tuning supported or not|No| |Fine-tuning supported or not|No|
...@@ -63,11 +63,11 @@ ...@@ -63,11 +63,11 @@
- ### 2、Installation - ### 2、Installation
```shell - ```shell
$hub install SkyAR $hub install SkyAR
``` ```
- In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_ch/get_start/windows_quickstart.md) - In case of any problems during installation, please refer to:[Windows_Quickstart](../../../../docs/docs_en/get_start/windows_quickstart.md)
| [Linux_Quickstart](../../../../docs/docs_ch/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_ch/get_start/mac_quickstart.md) | [Linux_Quickstart](../../../../docs/docs_en/get_start/linux_quickstart.md) | [Mac_Quickstart](../../../../docs/docs_en/get_start/mac_quickstart.md)
## III. Module API Prediction ## III. Module API Prediction
...@@ -99,13 +99,10 @@ ...@@ -99,13 +99,10 @@
* video_path(str)：input video path. * video_path(str)：input video path.
* save_path(str)：save videp path. * save_path(str)：save videp path.
* config(str): SkyBox configuration, all preset configurations are as follows, if you use a custom SkyBox, please set it to None: * config(str): SkyBox configuration, all preset configurations are as follows: `['cloudy', 'district9ship', 'floatingcastle', 'galaxy', 'jupiter',
```
[
'cloudy', 'district9ship', 'floatingcastle', 'galaxy', 'jupiter',
'rainy', 'sunny', 'sunset', 'supermoon', 'thunderstorm' 'rainy', 'sunny', 'sunset', 'supermoon', 'thunderstorm'
] ]`, if you use a custom SkyBox, please set it to None.
```
* skybox_img(str)：custom SkyBox image path * skybox_img(str)：custom SkyBox image path
* skybox_video(str)：custom SkyBox video path * skybox_video(str)：custom SkyBox video path
* is_video_sky(bool)：customize whether SkyBox is a video * is_video_sky(bool)：customize whether SkyBox is a video
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或