Skip to content

Commit

Permalink
Merge pull request #5527 from FederatedAI/feature-2.1.0-update_dag_doc
Browse files Browse the repository at this point in the history
update readme of doc
  • Loading branch information
mgqa34 authored Mar 6, 2024
2 parents 005d9a1 + 8a9baac commit ba6d1a0
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 13 deletions.
2 changes: 1 addition & 1 deletion doc/2.0/fate/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ hetero_secureboost_0 = HeteroSecureBoost(

# create evaluation component_desc
evaluation_0 = Evaluation(
'evaluation_0', runtime_parties=dict(guest="9999"), metrics=["auc"], input_data=[hetero_secureboost_0.outputs["train_data_output"]]
'evaluation_0', runtime_parties=dict(guest="9999"), metrics=["auc"], input_datas=[hetero_secureboost_0.outputs["train_output_data"]]
)

# add training task
Expand Down
8 changes: 8 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Document Guidelines

Here are Some tutorial guides:

[Dag Usage Guide](./2.0/fate/dag.md)
[Component Developing Guides](./develop_guide/component_guide.md)
[Mainly Algorithms Performance On Multiple Engines](./2.0/fate/performance/performance_multi_engines.md)
[Mainly Algorithms Performance Comparison With FATE-v1.11.4](./2.0/fate/performance/performance_comparison.md)
24 changes: 12 additions & 12 deletions doc/tutorial/pipeline_tutorial_hetero.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
},
{
"cell_type": "code",
"execution_count": 1,
"execution_count": 2,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -61,7 +61,7 @@
},
{
"cell_type": "code",
"execution_count": 2,
"execution_count": 3,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -99,7 +99,7 @@
},
{
"cell_type": "code",
"execution_count": 3,
"execution_count": 4,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -124,7 +124,7 @@
},
{
"cell_type": "code",
"execution_count": 4,
"execution_count": 5,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -140,7 +140,7 @@
},
{
"cell_type": "code",
"execution_count": 5,
"execution_count": 6,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -158,7 +158,7 @@
},
{
"cell_type": "code",
"execution_count": 6,
"execution_count": 7,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -174,7 +174,7 @@
},
{
"cell_type": "code",
"execution_count": 7,
"execution_count": 8,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -198,14 +198,14 @@
},
{
"cell_type": "code",
"execution_count": 8,
"execution_count": 9,
"metadata": {},
"outputs": [],
"source": [
"evaluation_0 = Evaluation(\"evaluation_0\",\n",
" runtime_parties=dict(guest='9999'),\n",
" default_eval_setting=\"binary\",\n",
" input_data=lr_0.outputs[\"train_output_data\"])"
" input_datas=lr_0.outputs[\"train_output_data\"])"
]
},
{
Expand All @@ -216,8 +216,8 @@
"\n",
" - `psi_0` is responsible for finding overlapping match id\n",
" - `lr_0` trains Coordinated LR on data output by `psi_0`\n",
" - `lr_1` predicts with model from `sbt_0`\n",
" - `evaluation_0` consumes `sbt_0`'s prediciton result on training data\n",
" - `lr_1` predicts with model from `lr_0`\n",
" - `evaluation_0` consumes `lr_0`'s prediciton result on training data\n",
"\n",
"Then compile our pipeline to make it ready for submission."
]
Expand Down Expand Up @@ -687,7 +687,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.10"
"version": "3.9.7"
}
},
"nbformat": 4,
Expand Down

0 comments on commit ba6d1a0

Please sign in to comment.