Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
3dc1b52
add new doc structure
chesterxgchen Dec 25, 2025
e74e94b
add new doc structure
chesterxgchen Dec 25, 2025
f9f0940
add new doc structure
chesterxgchen Dec 26, 2025
23fe010
update doc
chesterxgchen Dec 26, 2025
e7e0225
add new doc structure
chesterxgchen Dec 26, 2025
da80e18
add new doc structure
chesterxgchen Dec 26, 2025
efc39fb
update doc
chesterxgchen Dec 26, 2025
ff1e1bb
add new doc structure
chesterxgchen Dec 26, 2025
e21cf86
update doc
chesterxgchen Dec 26, 2025
749cf6f
add new doc structure
chesterxgchen Dec 26, 2025
962fb66
update doc
chesterxgchen Dec 26, 2025
7f64e7f
update doc
chesterxgchen Dec 26, 2025
aafe231
add new doc structure
chesterxgchen Dec 27, 2025
d17a3b3
update doc
chesterxgchen Dec 27, 2025
944c35a
update doc
chesterxgchen Dec 27, 2025
bce5543
add new doc structure
chesterxgchen Dec 27, 2025
fe4baab
add new doc structure
chesterxgchen Dec 27, 2025
fc3124d
update doc
chesterxgchen Dec 27, 2025
b8ed37d
add new doc structure
chesterxgchen Dec 27, 2025
001e6e9
add new doc structure
chesterxgchen Dec 27, 2025
61d1231
add new doc structure
chesterxgchen Dec 27, 2025
afc7bf4
update doc
chesterxgchen Dec 27, 2025
05c7d9b
add new doc structure
chesterxgchen Dec 28, 2025
2e73412
Merge remote-tracking branch 'origin/documentation_update' into docum…
chesterxgchen Dec 28, 2025
7072609
update doc
chesterxgchen Dec 28, 2025
444fb91
add new doc structure
chesterxgchen Dec 28, 2025
6934dcd
update doc
chesterxgchen Dec 28, 2025
b011ca7
add new doc structure
chesterxgchen Dec 28, 2025
1078ae1
update doc
chesterxgchen Dec 28, 2025
5bc78ec
add new doc structure
chesterxgchen Dec 28, 2025
ae81ce6
update doc
chesterxgchen Dec 28, 2025
f6d247f
add new doc structure
chesterxgchen Dec 28, 2025
f52bcbc
update doc
chesterxgchen Dec 28, 2025
bbc5b7a
update doc
chesterxgchen Dec 28, 2025
df58c3a
add new doc structure
chesterxgchen Dec 28, 2025
411867d
add new doc structure
chesterxgchen Dec 28, 2025
29293a9
update place holders
chesterxgchen Dec 28, 2025
734d8a2
update place holders
chesterxgchen Dec 28, 2025
45eec01
update doc
chesterxgchen Dec 28, 2025
cc1e371
update doc
chesterxgchen Dec 28, 2025
b43d0dc
update doc
chesterxgchen Dec 28, 2025
4cbb3e3
update doc
chesterxgchen Dec 28, 2025
3c991cd
update doc
chesterxgchen Dec 28, 2025
fae1106
update doc
chesterxgchen Dec 28, 2025
cca50c7
remove k8s installation doc. as It's not ready for user
chesterxgchen Dec 29, 2025
3d287ef
Merge branch 'main' into documentation_update
chesterxgchen Dec 29, 2025
f4767d6
update image and design principles based on comments
chesterxgchen Dec 30, 2025
5fbdc5d
update image and design principles based on comments
chesterxgchen Dec 30, 2025
59c0fcc
Merge branch 'main' into documentation_update
chesterxgchen Jan 5, 2026
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
301 changes: 198 additions & 103 deletions docs/flare_overview.rst

Large diffs are not rendered by default.

260 changes: 0 additions & 260 deletions docs/flare_system_architecure.rst

This file was deleted.

3 changes: 2 additions & 1 deletion docs/hello-world/hello-lightning/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.. _hello_lightning:

Hello Pytorch Lightning
Hello PyTorch Lightning
=======================

This example demonstrates how to use NVIDIA FLARE with PyTorch lightning to train an image classifier using
Expand Down
2 changes: 2 additions & 0 deletions docs/hello-world/hello-pt/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _hello_pt:

Hello PyTorch
=============

Expand Down
12 changes: 8 additions & 4 deletions docs/hello-world/hello-tabular-stats/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _hello_tabular_stats:

Tabular Data Federated Statistics
=================================

Expand Down Expand Up @@ -91,7 +93,7 @@ Code Structure
Data
----

In this example, we are using UCI (University of California, Irvine) [adult dataset](https://archive.ics.uci.edu/dataset/2/adult)
In this example, we are using the UCI (University of California, Irvine) `adult dataset <https://archive.ics.uci.edu/dataset/2/adult>`_.

The original dataset has already contains "training" and "test" datasets. Here we simply assume that "training" and test data sets are belong to different clients.
so we assigned the training data and test data into two clients.
Expand Down Expand Up @@ -199,9 +201,11 @@ The results are stored in workspace "/tmp/nvflare"
/tmp/nvflare/simulation/stats_df/server/simulate_job/statistics/adults_stats.json


## Visualization
with json format, the data can be easily visualized via pandas dataframe and plots.
download and copy the output adults_stats.json file to demo directory, then you can run jupyter notebook visualization.ipynb
Visualization
-------------

With JSON format, the data can be easily visualized via Pandas DataFrame and plots.
Download and copy the output ``adults_stats.json`` file to the demo directory, then run the Jupyter notebook ``visualization.ipynb``.



Expand Down
4 changes: 3 additions & 1 deletion docs/hello-world/hello-tf/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _hello_tf:

Hello TensorFlow
================

Expand Down Expand Up @@ -51,7 +53,7 @@ Code Structure

.. code-block:: text

hello-pt
hello-tf
|
|-- client.py # client local training script
|-- model.py # model definition
Expand Down
24 changes: 24 additions & 0 deletions docs/how-to-guide/develop.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _how_to_develop_guide:

####################
How To Develop Guide
####################

How to install and turn existing stand-alone, centralized applications into federated learning applications.

Installation Guide
------------------
.. toctree::
:maxdepth: 1

../installation

Federated Application
---------------------

.. toctree::
:maxdepth: 1
:glob:

develop/*

Loading
Loading