From 8f8ab2c0fe4f4c090e51531f20e2de25fc85136a Mon Sep 17 00:00:00 2001 From: jingqinghe Date: Sun, 17 May 2020 18:59:44 +0800 Subject: [PATCH] update document --- docs/source/examples/md/dpsgd-example.md | 27 ++++++++++++++++----- docs/source/examples/md/gru4rec_examples.md | 16 ++++++------ docs/source/examples/md/sec_agg_example.md | 16 ++++++++++-- 3 files changed, 44 insertions(+), 15 deletions(-) diff --git a/docs/source/examples/md/dpsgd-example.md b/docs/source/examples/md/dpsgd-example.md index 20f8025..f3dd18f 100644 --- a/docs/source/examples/md/dpsgd-example.md +++ b/docs/source/examples/md/dpsgd-example.md @@ -4,14 +4,14 @@ This document introduces how to use PaddleFL to train a model with Fl Strategy: ### Dependencies -- paddlepaddle>=1.6 +- paddlepaddle>=1.8 ### How to install PaddleFL -Please use python which has paddlepaddle installed +Please use pip which has paddlepaddle installed ``` -python setup.py install +pip install paddle_fl ``` ### Model @@ -98,15 +98,28 @@ job_generator.generate_fl_job( strategy, server_endpoints=endpoints, worker_num=2, output=output) ``` -How to work in RunTime +#### How to work in RunTime ``` python -u fl_scheduler.py >scheduler.log & python -u fl_server.py >server0.log & -python -u fl_trainer.py 0 data/ >trainer0.log & -python -u fl_trainer.py 1 data/ >trainer1.log & +python -u fl_trainer.py 0 >trainer0.log & +python -u fl_trainer.py 1 >trainer1.log & +python -u fl_trainer.py 2 >trainer2.log & +python -u fl_trainer.py 3 >trainer3.log & ``` +In fl_scheduler.py, we let server and trainers to do registeration. +``` +worker_num = 4 +server_num = 1 +#Define number of worker/server and the port for scheduler +scheduler = FLScheduler(worker_num, server_num, port=9091) +scheduler.set_sample_worker_num(4) +scheduler.init_env() +print("init env done.") +scheduler.start_fl_training() +``` In fl_server.py, we load and run the FL server job. ``` @@ -115,7 +128,9 @@ server_id = 0 job_path = "fl_job_config" job = FLRunTimeJob() job.load_server_job(job_path, server_id) +job._scheduler_ep = "127.0.0.1:9091" # IP address for scheduler server.set_server_job(job) +server._current_ep = "127.0.0.1:8181" # IP address for server server.start() ``` diff --git a/docs/source/examples/md/gru4rec_examples.md b/docs/source/examples/md/gru4rec_examples.md index b40e9eb..33d4493 100644 --- a/docs/source/examples/md/gru4rec_examples.md +++ b/docs/source/examples/md/gru4rec_examples.md @@ -3,12 +3,13 @@ This document introduces how to use PaddleFL to train a model with Fl Strategy. ### Dependencies -- paddlepaddle>=1.6 +- paddlepaddle>=1.8 ### How to install PaddleFL -Please use python which has paddlepaddle installed + +Please use pip which has paddlepaddle installed ```sh -python setup.py install +pip install paddle_fl ``` ### Model @@ -20,7 +21,6 @@ Public Dataset [Rsc15](https://2015.recsyschallenge.com) ```sh #download data -cd example/gru4rec_demo sh download.sh ``` @@ -63,7 +63,7 @@ strategy = build_strategy.create_fl_strategy() endpoints = ["127.0.0.1:8181"] output = "fl_job_config" job_generator.generate_fl_job( - strategy, server_endpoints=endpoints, worker_num=2, output=output) + strategy, server_endpoints=endpoints, worker_num=4, output=output) ``` @@ -72,8 +72,10 @@ job_generator.generate_fl_job( ```sh python -u fl_scheduler.py >scheduler.log & python -u fl_server.py >server0.log & -python -u fl_trainer.py 0 data/ >trainer0.log & -python -u fl_trainer.py 1 data/ >trainer1.log & +python -u fl_trainer.py 0 >trainer0.log & +python -u fl_trainer.py 1 >trainer1.log & +python -u fl_trainer.py 2 >trainer2.log & +python -u fl_trainer.py 3 >trainer3.log & ``` fl_trainer.py can define own reader according to data. ```python diff --git a/docs/source/examples/md/sec_agg_example.md b/docs/source/examples/md/sec_agg_example.md index 3e678e6..08d9751 100644 --- a/docs/source/examples/md/sec_agg_example.md +++ b/docs/source/examples/md/sec_agg_example.md @@ -8,7 +8,7 @@ This document introduces how to use PaddleFL to train a model with Fl Strategy: ### How to install PaddleFL -Please use python which has paddlepaddle installed +Please use pip which has paddlepaddle installed ``` pip install paddle_fl @@ -96,7 +96,7 @@ job_generator.generate_fl_job( ``` -How to work in RunTime +#### How to work in RunTime ```shell python3 fl_master.py @@ -107,6 +107,18 @@ python3 -u fl_trainer.py 0 >log/trainer0.log & sleep 2 python3 -u fl_trainer.py 1 >log/trainer1.log & ``` +In fl_scheduler.py, we let server and trainers to do registeration. + +``` +worker_num = 2 +server_num = 1 +#Define number of worker/server and the port for scheduler +scheduler = FLScheduler(worker_num, server_num, port=9091) +scheduler.set_sample_worker_num(2) +scheduler.init_env() +print("init env done.") +scheduler.start_fl_training() +``` In fl_server.py, we load and run the FL server job. -- GitLab