[2.5] Cherry pick Update documentation for Dockerfile, add location o…

…f tbevents, fix link (#3006) * cherry pick Update documentation for Dockerfile, add location of tbevents, fix link * fix the entry for getting started in the TOC * update branch version --------- Co-authored-by: Isaac Yang <[email protected]> Co-authored-by: Yuan-Ting Hsieh (謝沅廷) <[email protected]>
NVIDIA · Oct 8, 2024 · 348ddb1 · 348ddb1
1 parent 4a7bc6a
commit 348ddb1
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 4 deletions.
diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -1,3 +1,7 @@
+# For Running NVIDIA FLARE in a Docker container, see
+# https://nvflare.readthedocs.io/en/main/quickstart.html#containerized-deployment-with-docker
+# This Dockerfile is primarily for building Docker images to publish for dashboard.
+
 FROM python:3.8
 RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get -y install zip
 COPY nvflare /opt/NVFlare/nvflare

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,7 +10,7 @@ NVIDIA FLARE
    fl_introduction
    flare_overview
    whats_new
-   getting_started
+   Getting Started <quickstart>
 
 .. toctree::
    :maxdepth: -1

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -93,7 +93,7 @@ Clone NVFlare repo to get examples, and switch to either the main branch or the
 
   $ git clone https://github.com/NVIDIA/NVFlare.git
   $ cd NVFlare
-  $ git switch 2.4
+  $ git switch 2.5
 
 Note on branches:
 

diff --git a/docs/resources/Dockerfile b/docs/resources/Dockerfile
@@ -1,7 +1,7 @@
-ARG PYTORCH_IMAGE=nvcr.io/nvidia/pytorch:24.03-py3
+ARG PYTORCH_IMAGE=nvcr.io/nvidia/pytorch:24.07-py3
 FROM ${PYTORCH_IMAGE}
 
-ARG NVF_VERSION=2.4
+ARG NVF_VERSION=2.5
 ENV NVF_BRANCH=${NVF_VERSION}
 
 RUN python3 -m pip install -U pip

diff --git a/examples/hello-world/hello-pt/README.md b/examples/hello-world/hello-pt/README.md
@@ -41,3 +41,11 @@ You can find the running logs and results inside the simulator's workspace:
 ```bash
 $ ls /tmp/nvflare/jobs/workdir/
 ```
+
+By default, the Tensorboard event logs can be found in the directory for each client on the server job's tb_events folder,
+for example:
+
+```bash
+$ ls /tmp/nvflare/jobs/workdir/server/simulate_job/tb_events/site-1
+events.out.tfevents.1728070846.machinename.15928.1
+```