Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix pytorch readme formatting #566

Merged
merged 1 commit into from
Apr 8, 2024
Merged

Fix pytorch readme formatting #566

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions examples/mnist-pytorch/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Quickstart Tutorial PyTorch (MNIST)
-------------
-------------------------------------

This classic example of hand-written text recognition is well suited as a lightweight test when developing on FEDn in pseudo-distributed mode.
A normal high-end laptop or a workstation should be able to sustain a few clients.
Expand Down Expand Up @@ -112,8 +112,8 @@ You are now ready to use the API to initialize the system with the compute packa
- Follow the example in the `Jupyter Notebook <https://github.com/scaleoutsystems/fedn/blob/master/examples/mnist-pytorch/API_Example.ipynb>`__


Automate experimentation with several clients:
-----------
Automate experimentation with several clients
-----------------------------------------------

Now that you have an understanding of the main components of FEDn, you can use the provided docker-compose templates to automate deployment of FEDn and clients.
To start the network and attach 4 clients:
Expand All @@ -124,7 +124,7 @@ To start the network and attach 4 clients:


Access logs and validation data from MongoDB
-----------
---------------------------------------------
You can access and download event logs and validation data via the API, and you can also as a developer obtain
the MongoDB backend data using pymongo or via the MongoExpress interface:

Expand All @@ -133,7 +133,7 @@ the MongoDB backend data using pymongo or via the MongoExpress interface:
The credentials are as set in docker-compose.yaml in the root of the repository.

Access model updates
-----------
---------------------

You can obtain model updates from the 'fedn-models' bucket in Minio:

Expand Down
Loading