diff --git a/.gitignore b/.gitignore index ec86d20d..810f7a58 100755 --- a/.gitignore +++ b/.gitignore @@ -35,4 +35,5 @@ puffer landmark coqa .idea -out/ \ No newline at end of file +out/ +build/ \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index e1eea660..a45f2ee0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,7 +19,7 @@ # -- Project information ----------------------------------------------------- project = 'fedscale' -copyright = '2022, FedScale Team' +copyright = '2023, FedScale Team' author = 'FedScale Team' # The full version, including alpha/beta/rc tags diff --git a/docs/source/fedscale.cloud.aggregation.rst b/docs/source/fedscale.cloud.aggregation.rst index e79ee136..307be4e4 100644 --- a/docs/source/fedscale.cloud.aggregation.rst +++ b/docs/source/fedscale.cloud.aggregation.rst @@ -1,27 +1,27 @@ fedscale.cloud.aggregation package -================================= - -.. Subpackages -.. ----------- - -.. .. toctree:: -.. :maxdepth: 4 - -.. fedscale.cloud.aggregation.android +================================== Submodules ---------- fedscale.cloud.aggregation.aggregator module -------------------------------------------- +-------------------------------------------- .. automodule:: fedscale.cloud.aggregation.aggregator :members: :undoc-members: :show-inheritance: +fedscale.cloud.aggregation.android\_aggregator module +----------------------------------------------------- + +.. automodule:: fedscale.cloud.aggregation.android_aggregator + :members: + :undoc-members: + :show-inheritance: + fedscale.cloud.aggregation.optimizers module -------------------------------------------- +-------------------------------------------- .. automodule:: fedscale.cloud.aggregation.optimizers :members: diff --git a/docs/source/fedscale.cloud.execution.rst b/docs/source/fedscale.cloud.execution.rst index 6754bfb0..9d9ab203 100644 --- a/docs/source/fedscale.cloud.execution.rst +++ b/docs/source/fedscale.cloud.execution.rst @@ -1,48 +1,64 @@ fedscale.cloud.execution package -=============================== +================================ Submodules ---------- -.. fedscale.cloud.execution.client module -.. ------------------------------------- +fedscale.cloud.execution.client\_base module +-------------------------------------------- -.. .. automodule:: fedscale.cloud.execution.client -.. :members: -.. :undoc-members: -.. :show-inheritance: +.. automodule:: fedscale.cloud.execution.client_base + :members: + :undoc-members: + :show-inheritance: -.. fedscale.cloud.execution.data\_processor module -.. ---------------------------------------------- +fedscale.cloud.execution.data\_processor module +----------------------------------------------- -.. .. automodule:: fedscale.cloud.execution.data_processor -.. :members: -.. :undoc-members: -.. :show-inheritance: +.. automodule:: fedscale.cloud.execution.data_processor + :members: + :undoc-members: + :show-inheritance: fedscale.cloud.execution.executor module ---------------------------------------- +---------------------------------------- .. automodule:: fedscale.cloud.execution.executor :members: :undoc-members: :show-inheritance: -.. fedscale.cloud.execution.optimizers module -.. ----------------------------------------- +fedscale.cloud.execution.optimizers module +------------------------------------------ + +.. automodule:: fedscale.cloud.execution.optimizers + :members: + :undoc-members: + :show-inheritance: + +fedscale.cloud.execution.rl\_client module +------------------------------------------ -.. .. automodule:: fedscale.cloud.execution.optimizers -.. :members: -.. :undoc-members: -.. :show-inheritance: +.. automodule:: fedscale.cloud.execution.rl_client + :members: + :undoc-members: + :show-inheritance: -.. fedscale.cloud.execution.rlclient module -.. --------------------------------------- +fedscale.cloud.execution.tensorflow\_client module +-------------------------------------------------- -.. .. automodule:: fedscale.cloud.execution.rlclient -.. :members: -.. :undoc-members: -.. :show-inheritance: +.. automodule:: fedscale.cloud.execution.tensorflow_client + :members: + :undoc-members: + :show-inheritance: + +fedscale.cloud.execution.torch\_client module +--------------------------------------------- + +.. automodule:: fedscale.cloud.execution.torch_client + :members: + :undoc-members: + :show-inheritance: Module contents --------------- diff --git a/docs/source/fedscale.cloud.rst b/docs/source/fedscale.cloud.rst index 4828cfee..4f9843e6 100644 --- a/docs/source/fedscale.cloud.rst +++ b/docs/source/fedscale.cloud.rst @@ -1,5 +1,5 @@ fedscale.cloud package -===================== +====================== Subpackages ----------- @@ -14,7 +14,7 @@ Submodules ---------- fedscale.cloud.client\_manager module ------------------------------------- +------------------------------------- .. automodule:: fedscale.cloud.client_manager :members: @@ -22,7 +22,7 @@ fedscale.cloud.client\_manager module :show-inheritance: fedscale.cloud.commons module ----------------------------- +----------------------------- .. automodule:: fedscale.cloud.commons :members: @@ -30,7 +30,7 @@ fedscale.cloud.commons module :show-inheritance: fedscale.cloud.config\_parser module ------------------------------------ +------------------------------------ .. automodule:: fedscale.cloud.config_parser :members: @@ -38,7 +38,7 @@ fedscale.cloud.config\_parser module :show-inheritance: fedscale.cloud.fllibs module ---------------------------- +---------------------------- .. automodule:: fedscale.cloud.fllibs :members: @@ -46,7 +46,7 @@ fedscale.cloud.fllibs module :show-inheritance: fedscale.cloud.resource\_manager module --------------------------------------- +--------------------------------------- .. automodule:: fedscale.cloud.resource_manager :members: diff --git a/docs/source/fedscale.edge.execution.rst b/docs/source/fedscale.edge.execution.rst new file mode 100644 index 00000000..3a8ff83c --- /dev/null +++ b/docs/source/fedscale.edge.execution.rst @@ -0,0 +1,88 @@ +fedscale.edge.execution +======================= + +`This directory `__ contains minimum files modified from `MNN Android +Demo `__. +The training and testing will be conducted by MNN C++ backend, while the +task execution and communication with server will be managed by Java. +The sample has been tested upon image classification with a simple +linear model and a small subset of +`ImageNet-MINI `__. +This documentation contains a step-by-step tutorial on how to download, +build and config this app on your own device, and modify this app for +your own implementation and deployment. + +Download and build sample android app +------------------------------------- + +1. Download and unzip `sample dataset + (TrainTest.zip) `__ + to ``assets/`` directory. Remove ``TrainTest.zip`` after unzip to + save space on your mobile device. After unzip, you should see 3 files + and 2 directories under ``assets/``: + + 1. ``TrainSet``: Training set directory, contains 316 images. + 2. ``TestSet``: Testing set directory, contains 34 images. + 3. ``conf.json``: Configuration file for mobile app. + 4. ``train_labels.txt``: Training label file with format + ``