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.

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

[2.5] Cherry pick Update documentation for Dockerfile, add location of tbevents, fix link #3006

Merged
merged 5 commits into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions docker/Dockerfile
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ NVIDIA FLARE
fl_introduction
flare_overview
whats_new
getting_started
Getting Started <quickstart>

.. toctree::
:maxdepth: -1
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/Dockerfile
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 8 additions & 0 deletions examples/hello-world/hello-pt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Loading