Skip to content

Commit 348ddb1

Browse files
nvkevluIsaacYangSLAYuanTingHsieh
authored
[2.5] Cherry pick Update documentation for Dockerfile, add location of 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]>
1 parent 4a7bc6a commit 348ddb1

File tree

5 files changed

+16
-4
lines changed

5 files changed

+16
-4
lines changed

docker/Dockerfile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# For Running NVIDIA FLARE in a Docker container, see
2+
# https://nvflare.readthedocs.io/en/main/quickstart.html#containerized-deployment-with-docker
3+
# This Dockerfile is primarily for building Docker images to publish for dashboard.
4+
15
FROM python:3.8
26
RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get -y install zip
37
COPY nvflare /opt/NVFlare/nvflare

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ NVIDIA FLARE
1010
fl_introduction
1111
flare_overview
1212
whats_new
13-
getting_started
13+
Getting Started <quickstart>
1414

1515
.. toctree::
1616
:maxdepth: -1

docs/quickstart.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Clone NVFlare repo to get examples, and switch to either the main branch or the
9393
9494
$ git clone https://github.com/NVIDIA/NVFlare.git
9595
$ cd NVFlare
96-
$ git switch 2.4
96+
$ git switch 2.5
9797
9898
Note on branches:
9999

docs/resources/Dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
ARG PYTORCH_IMAGE=nvcr.io/nvidia/pytorch:24.03-py3
1+
ARG PYTORCH_IMAGE=nvcr.io/nvidia/pytorch:24.07-py3
22
FROM ${PYTORCH_IMAGE}
33

4-
ARG NVF_VERSION=2.4
4+
ARG NVF_VERSION=2.5
55
ENV NVF_BRANCH=${NVF_VERSION}
66

77
RUN python3 -m pip install -U pip

examples/hello-world/hello-pt/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,11 @@ You can find the running logs and results inside the simulator's workspace:
4141
```bash
4242
$ ls /tmp/nvflare/jobs/workdir/
4343
```
44+
45+
By default, the Tensorboard event logs can be found in the directory for each client on the server job's tb_events folder,
46+
for example:
47+
48+
```bash
49+
$ ls /tmp/nvflare/jobs/workdir/server/simulate_job/tb_events/site-1
50+
events.out.tfevents.1728070846.machinename.15928.1
51+
```

0 commit comments

Comments
 (0)