diff --git a/examples/README.md b/examples/README.md index 7ff8b97389..c5951b8970 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1 +1,7 @@ -[https://doc.fedml.ai](https://doc.fedml.ai) \ No newline at end of file +- Documentation: [https://doc.fedml.ai](https://doc.fedml.ai) + +- Examples of FedML Python Library: [FedML/python/examples](./../python/examples) + +- Examples of FedML IoT: [FedML/iot](../iot) + +- Examples of FedML Android: [FedML/android](../android) \ No newline at end of file diff --git a/ios/README.md b/ios/README.md new file mode 100644 index 0000000000..50ccaaeb3a --- /dev/null +++ b/ios/README.md @@ -0,0 +1 @@ +We will release iOS SDK soon. Please use Android SDK first. \ No newline at end of file diff --git a/mobile/README.md b/mobile/README.md deleted file mode 100644 index 2a3652a0bc..0000000000 --- a/mobile/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# FedML-Mobile: Federated Learning Research Library for Android and iOS Smartphones (supported by FedML framework) - -# Installation -http://doc.fedml.ai/#/installation - -After the clone of this repository, please run the following command to get `FedML` submodule to your local. -``` -cd FedML -git submodule init -git submodule update -``` - - -# Update FedML Submodule -``` -cd FedML -git checkout master && git pull -cd .. -git add FedML -git commit -m "updating submodule FedML to latest" -git push -``` - - -# On-device training for Android - -This project aims at training NN with non-IID dataset on Android device, involving doing training independently on device and updating NN in server using FedAvg Algorithm. - -We published a demo of training a LR model built with Deeplearning4J on Android Studio. - -Please check this out: https://github.com/FedML-AI/FedML-Mobile/tree/master/android/fedml-iot-sdk/src/main/java/ai/fedml/iot/service/FedML_client_training_demo diff --git a/mobile/android/README.md b/mobile/android/README.md deleted file mode 100644 index 66a1c72522..0000000000 --- a/mobile/android/README.md +++ /dev/null @@ -1 +0,0 @@ -this is where we maintain FedML Android SDK and Android Application. \ No newline at end of file diff --git a/mobile/ios/README.md b/mobile/ios/README.md deleted file mode 100644 index 2aeef55af4..0000000000 --- a/mobile/ios/README.md +++ /dev/null @@ -1 +0,0 @@ -iOS is under development. Please use Android first. \ No newline at end of file diff --git a/python/app/fediot/__init__.py b/python/app/fediot/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/python/app/mpi_host_file b/python/app/mpi_host_file new file mode 100644 index 0000000000..a32973a64e --- /dev/null +++ b/python/app/mpi_host_file @@ -0,0 +1 @@ +104-171-200-171 diff --git a/test/android_protocol_test/mqtt_communicator.py b/python/tests/android_protocol_test/mqtt_communicator.py similarity index 100% rename from test/android_protocol_test/mqtt_communicator.py rename to python/tests/android_protocol_test/mqtt_communicator.py diff --git a/test/android_protocol_test/test_protocol.py b/python/tests/android_protocol_test/test_protocol.py similarity index 100% rename from test/android_protocol_test/test_protocol.py rename to python/tests/android_protocol_test/test_protocol.py diff --git a/test/grpc_benchmark/README.md b/python/tests/grpc_benchmark/README.md similarity index 100% rename from test/grpc_benchmark/README.md rename to python/tests/grpc_benchmark/README.md diff --git a/test/grpc_benchmark/benchmark/README.md b/python/tests/grpc_benchmark/benchmark/README.md similarity index 100% rename from test/grpc_benchmark/benchmark/README.md rename to python/tests/grpc_benchmark/benchmark/README.md diff --git a/test/grpc_benchmark/benchmark/benchmark.proto b/python/tests/grpc_benchmark/benchmark/benchmark.proto similarity index 100% rename from test/grpc_benchmark/benchmark/benchmark.proto rename to python/tests/grpc_benchmark/benchmark/benchmark.proto diff --git a/test/grpc_benchmark/benchmark/benchmark_pb2.py b/python/tests/grpc_benchmark/benchmark/benchmark_pb2.py similarity index 100% rename from test/grpc_benchmark/benchmark/benchmark_pb2.py rename to python/tests/grpc_benchmark/benchmark/benchmark_pb2.py diff --git a/test/grpc_benchmark/benchmark/benchmark_pb2_grpc.py b/python/tests/grpc_benchmark/benchmark/benchmark_pb2_grpc.py similarity index 100% rename from test/grpc_benchmark/benchmark/benchmark_pb2_grpc.py rename to python/tests/grpc_benchmark/benchmark/benchmark_pb2_grpc.py diff --git a/test/grpc_benchmark/benchmark/build.sh b/python/tests/grpc_benchmark/benchmark/build.sh similarity index 100% rename from test/grpc_benchmark/benchmark/build.sh rename to python/tests/grpc_benchmark/benchmark/build.sh diff --git a/test/grpc_benchmark/benchmark/common.py b/python/tests/grpc_benchmark/benchmark/common.py similarity index 100% rename from test/grpc_benchmark/benchmark/common.py rename to python/tests/grpc_benchmark/benchmark/common.py diff --git a/test/grpc_benchmark/benchmark/grpc_client.py b/python/tests/grpc_benchmark/benchmark/grpc_client.py similarity index 97% rename from test/grpc_benchmark/benchmark/grpc_client.py rename to python/tests/grpc_benchmark/benchmark/grpc_client.py index baae8863fc..9c4ef179a4 100644 --- a/test/grpc_benchmark/benchmark/grpc_client.py +++ b/python/tests/grpc_benchmark/benchmark/grpc_client.py @@ -13,14 +13,6 @@ from common import ( - identity, - identity_script, - heavy, - heavy_script, - identity_cuda, - identity_script_cuda, - heavy_cuda, - heavy_script_cuda, stamp_time, compute_delay, NUM_RPC, diff --git a/test/grpc_benchmark/benchmark/grpc_server.py b/python/tests/grpc_benchmark/benchmark/grpc_server.py similarity index 100% rename from test/grpc_benchmark/benchmark/grpc_server.py rename to python/tests/grpc_benchmark/benchmark/grpc_server.py diff --git a/test/grpc_benchmark/benchmark/images/gpt.pdf b/python/tests/grpc_benchmark/benchmark/images/gpt.pdf similarity index 100% rename from test/grpc_benchmark/benchmark/images/gpt.pdf rename to python/tests/grpc_benchmark/benchmark/images/gpt.pdf diff --git a/test/grpc_benchmark/benchmark/images/large_heavy.pdf b/python/tests/grpc_benchmark/benchmark/images/large_heavy.pdf similarity index 100% rename from test/grpc_benchmark/benchmark/images/large_heavy.pdf rename to python/tests/grpc_benchmark/benchmark/images/large_heavy.pdf diff --git a/test/grpc_benchmark/benchmark/images/large_light.pdf b/python/tests/grpc_benchmark/benchmark/images/large_light.pdf similarity index 100% rename from test/grpc_benchmark/benchmark/images/large_light.pdf rename to python/tests/grpc_benchmark/benchmark/images/large_light.pdf diff --git a/test/grpc_benchmark/benchmark/images/nlp_multi_128.pdf b/python/tests/grpc_benchmark/benchmark/images/nlp_multi_128.pdf similarity index 100% rename from test/grpc_benchmark/benchmark/images/nlp_multi_128.pdf rename to python/tests/grpc_benchmark/benchmark/images/nlp_multi_128.pdf diff --git a/test/grpc_benchmark/benchmark/images/nlp_multi_32.pdf b/python/tests/grpc_benchmark/benchmark/images/nlp_multi_32.pdf similarity index 100% rename from test/grpc_benchmark/benchmark/images/nlp_multi_32.pdf rename to python/tests/grpc_benchmark/benchmark/images/nlp_multi_32.pdf diff --git a/test/grpc_benchmark/benchmark/images/nlp_single.pdf b/python/tests/grpc_benchmark/benchmark/images/nlp_single.pdf similarity index 100% rename from test/grpc_benchmark/benchmark/images/nlp_single.pdf rename to python/tests/grpc_benchmark/benchmark/images/nlp_single.pdf diff --git a/test/grpc_benchmark/benchmark/images/small_heavy.pdf b/python/tests/grpc_benchmark/benchmark/images/small_heavy.pdf similarity index 100% rename from test/grpc_benchmark/benchmark/images/small_heavy.pdf rename to python/tests/grpc_benchmark/benchmark/images/small_heavy.pdf diff --git a/test/grpc_benchmark/benchmark/images/small_light.pdf b/python/tests/grpc_benchmark/benchmark/images/small_light.pdf similarity index 100% rename from test/grpc_benchmark/benchmark/images/small_light.pdf rename to python/tests/grpc_benchmark/benchmark/images/small_light.pdf diff --git a/test/grpc_benchmark/benchmark/images/small_light_multi.pdf b/python/tests/grpc_benchmark/benchmark/images/small_light_multi.pdf similarity index 100% rename from test/grpc_benchmark/benchmark/images/small_light_multi.pdf rename to python/tests/grpc_benchmark/benchmark/images/small_light_multi.pdf diff --git a/test/grpc_benchmark/benchmark/images/small_light_single.pdf b/python/tests/grpc_benchmark/benchmark/images/small_light_single.pdf similarity index 100% rename from test/grpc_benchmark/benchmark/images/small_light_single.pdf rename to python/tests/grpc_benchmark/benchmark/images/small_light_single.pdf diff --git a/test/grpc_benchmark/benchmark/multi_machine_launch.py b/python/tests/grpc_benchmark/benchmark/multi_machine_launch.py similarity index 97% rename from test/grpc_benchmark/benchmark/multi_machine_launch.py rename to python/tests/grpc_benchmark/benchmark/multi_machine_launch.py index fae1230330..901e68d712 100644 --- a/test/grpc_benchmark/benchmark/multi_machine_launch.py +++ b/python/tests/grpc_benchmark/benchmark/multi_machine_launch.py @@ -1,4 +1,3 @@ -import torch.multiprocessing as mp import pt_rpc_client import pt_rpc_server import grpc_client diff --git a/test/grpc_benchmark/benchmark/plot/draw_gpt.py b/python/tests/grpc_benchmark/benchmark/plot/draw_gpt.py similarity index 100% rename from test/grpc_benchmark/benchmark/plot/draw_gpt.py rename to python/tests/grpc_benchmark/benchmark/plot/draw_gpt.py diff --git a/test/grpc_benchmark/benchmark/plot/draw_nlp.py b/python/tests/grpc_benchmark/benchmark/plot/draw_nlp.py similarity index 100% rename from test/grpc_benchmark/benchmark/plot/draw_nlp.py rename to python/tests/grpc_benchmark/benchmark/plot/draw_nlp.py diff --git a/test/grpc_benchmark/benchmark/plot/draw_raw.py b/python/tests/grpc_benchmark/benchmark/plot/draw_raw.py similarity index 100% rename from test/grpc_benchmark/benchmark/plot/draw_raw.py rename to python/tests/grpc_benchmark/benchmark/plot/draw_raw.py diff --git a/test/grpc_benchmark/benchmark/plot/draw_rec.py b/python/tests/grpc_benchmark/benchmark/plot/draw_rec.py similarity index 100% rename from test/grpc_benchmark/benchmark/plot/draw_rec.py rename to python/tests/grpc_benchmark/benchmark/plot/draw_rec.py diff --git a/test/grpc_benchmark/benchmark/plot/draw_rl.py b/python/tests/grpc_benchmark/benchmark/plot/draw_rl.py similarity index 100% rename from test/grpc_benchmark/benchmark/plot/draw_rl.py rename to python/tests/grpc_benchmark/benchmark/plot/draw_rl.py diff --git a/test/grpc_benchmark/benchmark/pt_rpc_client.py b/python/tests/grpc_benchmark/benchmark/pt_rpc_client.py similarity index 100% rename from test/grpc_benchmark/benchmark/pt_rpc_client.py rename to python/tests/grpc_benchmark/benchmark/pt_rpc_client.py diff --git a/test/grpc_benchmark/benchmark/pt_rpc_server.py b/python/tests/grpc_benchmark/benchmark/pt_rpc_server.py similarity index 100% rename from test/grpc_benchmark/benchmark/pt_rpc_server.py rename to python/tests/grpc_benchmark/benchmark/pt_rpc_server.py diff --git a/test/grpc_benchmark/benchmark/run_client.sh b/python/tests/grpc_benchmark/benchmark/run_client.sh similarity index 100% rename from test/grpc_benchmark/benchmark/run_client.sh rename to python/tests/grpc_benchmark/benchmark/run_client.sh diff --git a/test/grpc_benchmark/benchmark/run_server.sh b/python/tests/grpc_benchmark/benchmark/run_server.sh similarity index 100% rename from test/grpc_benchmark/benchmark/run_server.sh rename to python/tests/grpc_benchmark/benchmark/run_server.sh diff --git a/test/grpc_benchmark/benchmark/single_machine_launch.py b/python/tests/grpc_benchmark/benchmark/single_machine_launch.py similarity index 100% rename from test/grpc_benchmark/benchmark/single_machine_launch.py rename to python/tests/grpc_benchmark/benchmark/single_machine_launch.py diff --git a/test/grpc_benchmark/requirements.txt b/python/tests/grpc_benchmark/requirements.txt similarity index 100% rename from test/grpc_benchmark/requirements.txt rename to python/tests/grpc_benchmark/requirements.txt diff --git a/test/mnn_mobile/model_utils.py b/python/tests/mnn_mobile/model_utils.py similarity index 100% rename from test/mnn_mobile/model_utils.py rename to python/tests/mnn_mobile/model_utils.py diff --git a/test/mnn_mobile/test_mnn_mnist.py b/python/tests/mnn_mobile/test_mnn_mnist.py similarity index 100% rename from test/mnn_mobile/test_mnn_mnist.py rename to python/tests/mnn_mobile/test_mnn_mnist.py diff --git a/test/test_pip_init/fedml_config.yaml b/python/tests/test_pip_init/fedml_config.yaml similarity index 100% rename from test/test_pip_init/fedml_config.yaml rename to python/tests/test_pip_init/fedml_config.yaml diff --git a/test/test_pip_init/main.py b/python/tests/test_pip_init/main.py similarity index 100% rename from test/test_pip_init/main.py rename to python/tests/test_pip_init/main.py