Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
charlesbvll committed Mar 4, 2024
1 parent 57e43cb commit ea6f42d
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions examples/custom-mods/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ app = fl.client.ClientApp(

### Tensorboard Flower Mod

The [Tensorboard] Mod will only differ in the initialization and how the data is sent to Tensorboard:
The [Tensorboard](https://www.tensorflow.org/tensorboard) Mod will only differ in the initialization and how the data is sent to Tensorboard:

```python
def get_tensorboard_mod(logdir) -> Mod:
Expand Down Expand Up @@ -268,6 +268,15 @@ def get_tensorboard_mod(logdir) -> Mod:

For the initialization, Tensorboard uses a custom directory path, which can, in this case, be passed as an argument to the wrapper function.

It can be used in the following way:

```python
app = fl.client.ClientApp(
client_fn=client_fn,
mods=[get_tensorboard_mod(".runs_history/")],
)
```

## Running the example

### Preconditions
Expand Down Expand Up @@ -337,4 +346,4 @@ For Tensorboard, you will need to run the following command in your terminal:
tensorboard --logdir <LOG_DIR>
```

Where `<LOG_DIR>` needs to be replaced by the directory passed as an argument to the wrapper function (`.runs_history/` by default).
Where `<LOG_DIR>` needs to be replaced by the directory passed as an argument to the wrapper function (`.runs_history/` by default).

0 comments on commit ea6f42d

Please sign in to comment.