From 348ddb1b6de2e182b4211b9918a67ddbe758822a Mon Sep 17 00:00:00 2001 From: nvkevlu <55759229+nvkevlu@users.noreply.github.com> Date: Mon, 7 Oct 2024 19:33:26 -0700 Subject: [PATCH] [2.5] Cherry pick Update documentation for Dockerfile, add location of tbevents, fix link (#3006) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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 Co-authored-by: Yuan-Ting Hsieh (謝沅廷) --- docker/Dockerfile | 4 ++++ docs/index.rst | 2 +- docs/quickstart.rst | 2 +- docs/resources/Dockerfile | 4 ++-- examples/hello-world/hello-pt/README.md | 8 ++++++++ 5 files changed, 16 insertions(+), 4 deletions(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index c30293bc0c..0192caa113 100644 --- 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 index 2ecb5e07eb..16e1fb8788 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,7 @@ NVIDIA FLARE fl_introduction flare_overview whats_new - getting_started + Getting Started .. toctree:: :maxdepth: -1 diff --git a/docs/quickstart.rst b/docs/quickstart.rst index eb59f53a6a..960f220227 100644 --- 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 index baefd870d8..54a84ad942 100644 --- 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 index e21a51543f..fd659ad4a3 100644 --- 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 +```