# DSL Conf Tutorial

This documentation will give a brief tutorial on how to run train & predict tasks with [DSL Conf](dsl_conf_v2_setting_guide.md).
We will take hetero-secureboost as an example.
	
## Upload Data

Before running jobs, data need to be uploaded to data storage. Please refer [here](./upload_data_guide.md) for an example.

## Submit a training task
We can start a training job by submitting conf & dsl through [Flow Client](../../api/fate_client/flow_client.rst),
Here we submit a hetero-secureboost binary classification task, whose conf and dsl are in [hetero secureboost example 
folder.](../../../examples/dsl/v2/hetero_secureboost)

```sh
$ flow job submit -c ./examples/dsl/v2/hetero_secureboost/test_secureboost_train_binary_conf.json -d ./examples/dsl/v2/hetero_secureboost/test_secureboost_train_dsl.json

{
    "data": {
        "board_url": "http://127.0.0.1:8080/index.html#/dashboard?job_id=2020103015490073208469&role=guest&party_id=10000",
        "job_dsl_path": "/fate/jobs/2020103015490073208469/job_dsl.json",
        "job_runtime_conf_path": "/fate/jobs/2020103015490073208469/job_runtime_conf.json",
        "logs_directory": "/fate/logs/2020103015490073208469",
        "model_info": {
            "model_id": "guest-10000#host-10000#model",
            "model_version": "2020103015490073208469"
        }
    },
    "jobId": "2020103015490073208469",
    "retcode": 0,
    "retmsg": "success"
}
```

Then we can get a return message contains model_id and model_version.

## Retrieve model_id and model_version
Forget to save model_id and model_version in the returned message? No worry. 
You can query the corresponding model_id and model_version of a job using the "flow job config" command.

```sh
$ flow job config -j 2020103015490073208469 -r guest -p 9999 -o ./
{
    "data": {
        "job_id": "2020103015490073208469",
        "model_info": {
            "model_id": "guest-10000#host-10000#model", <<- model_id needed for deploy model
            "model_version": "2020103015490073208469" <<- model_version needed for deploy model
        },
        "train_runtime_conf": {}
    },
    "retcode": 0,
    "retmsg": "download successfully, please check /fate/job_2020103015490073208469_config directory",
    "directory": "/fate/job_2020103015490073208469_config"
}
```
## Make a predict conf and generate predict dsl

We use flow_client to deploy components needed in the prediction task:

```sh
$ flow model deploy --model-id guest-10000#host-10000#model --model-version 2020103015490073208469 --cpn-list "data_transform_0, intersection_0, hetero_secure_boost_0"
{
    "data": {
        "detail": {
            "guest": {
                "10000": {
                    "retcode": 0,
                    "retmsg": "deploy model of role guest 10000 success"
                }
            },
            "host": {
                "9999": {
                    "retcode": 0,
                    "retmsg": "deploy model of role host 9999 success"
                }
            }
        },
        "guest": {
            "10000": 0
        },
        "host": {
            "9999": 0
        },
        "model_id": "guest-10000#host-9999#model",     <<-- used in predict conf
        "model_version": "2020103000555532513450"      <<-- used in predict conf
    },
    "retcode": 0,
    "retmsg": "success"
}
```

Then we can get a return message by deploy model contains model_id and model_version.

We can modify existing predict conf by replacing model_id, model_version and data set name with yours to make a new 
predict conf.
Here we replace model_id and model_version in [predict conf](../../../examples/dsl/v2/hetero_secureboost/test_predict_conf.json) 
with model_id and model_version returned by deploy model job.


```json
{
    "dsl_version": 2,
    "initiator": {
        "role": "guest",
        "party_id": 10000
    },
    "role": {
        "host": [
            9999
        ],
        "guest": [
            10000
        ]
    },
    "job_parameters": {
        "common": {
            "job_type": "predict",
            "model_id": "guest-10000#host-9999#model", <<-- to replace,return by deploy model
            "model_version": "20200928174750711017114"  <<-- to replace,return by deploy model
        }
    },
    "component_parameters": {
        "role": {
            "guest": {
                "0": {
                    "reader_0": {
                        "table": {
                            "name": "breast_hetero_guest", <<-- you can set new dataset here
                            "namespace": "experiment"
                        }
                    }
                }
            },
            "host": {
                "0": {
                    "reader_0": {
                        "table": {
                            "name": "breast_hetero_host",  <<-- you can set new dataset here
                            "namespace": "experiment"
                        }
                    }
                }
            }
        }
    }
}
```

We can also generate predict conf, model_id and model_version returned by deploy model:
```shell
flow model get-predict-conf --model-id guest-10000#host-9999#model --model-version 2020103000555532513450 -o ./
```
the file like predict_conf_******.json
```json
{
    "data": {
        "component_parameters": {
            "role": {
                "guest": {
                    "0": {
                        "reader_1": {
                            "table": {
                                "name": "name_to_be_filled_0",                  <<-- you can set new dataset here
                                "namespace": "namespace_to_be_filled_0"         <<-- you can set new dataset here
                            }
                        }
                    }
                },
                "host": {
                    "0": {
                        "reader_1": {
                            "table": {
                                "name": "name_to_be_filled_0",                 <<-- you can set new dataset here
                                "namespace": "namespace_to_be_filled_0"        <<-- you can set new dataset here
                            }
                        }
                    }
                }
            }
        },
        "dsl_version": 2,
        "initiator": {
            "party_id": 12001,
            "role": "guest"
        },
        "job_parameters": {
            "common": {
                "job_type": "predict",
                "model_id": "guest-10000#host-9999#model",   <<-- do not need set
                "model_version": "2020103000555532513450",   <<-- do not need set
            }
        },
        "role": {
            "guest": [
                12001
            ],
            "host": [
                12000
            ]
        }
    },
    "retcode": 0,
    "retmsg": "success"
}
```

## Submit a predict job
Then we can submit a new predict job:

```sh    
$ flow job submit -c ./examples/dsl/v2/hetero_secureboost/test_predict_conf.json
```