Skip to content

Commit

Permalink
Baselines docs updates (#1977)
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel J. Beutel <daniel@adap.com>
  • Loading branch information
jafermarq and danieljanes authored Jun 29, 2023
1 parent b66e0fe commit e3f75a0
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 2 deletions.
1 change: 0 additions & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@
# "color-brand-content": "#292F36",
# "color-admonition-background": "#F2B705",
# },
"announcement": 'Flower Summit 2023 <a href="https://flower.dev/conf/flower-summit-2023/">register now</a>',
}

# Add any paths that contain custom static files (such as style sheets) here,
Expand Down
2 changes: 1 addition & 1 deletion doc/source/contributing-baselines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ We are adopting `Hydra <https://hydra.cc/>`_ as the default mechanism to manage
Usability
---------

Flower is known and loved for its usability. Therefore, make sure that your baseline or experiment can be executed with a single command such as :code:`conda run -m <your-baseline>.main` or :code:`python main.py` (when sourced into your environment). We provide you with a `template-baseline <https://github.com/adap/flower/tree/sor_template/baselines/flwr_baselines>`_ to use as guidance when contributing your baseline. Having all baselines follow a homogenous structure helps users to tryout many baselines without the overheads of having to understand each individual codebase. Similarly, by using Hydra throughout, users will immediately know how to parameterise your experiments directly from the command line.
Flower is known and loved for its usability. Therefore, make sure that your baseline or experiment can be executed with a single command such as :code:`conda run -m <your-baseline>.main` or :code:`python main.py` (when sourced into your environment). We provide you with a `template-baseline <https://github.com/adap/flower/tree/main/baselines/baseline_template>`_ to use as guidance when contributing your baseline. Having all baselines follow a homogenous structure helps users to tryout many baselines without the overheads of having to understand each individual codebase. Similarly, by using Hydra throughout, users will immediately know how to parameterise your experiments directly from the command line.

We look forward to your contribution!

0 comments on commit e3f75a0

Please sign in to comment.