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

docs(framework) Update how-to-run-simulations page #4492

Merged
merged 12 commits into from
Nov 17, 2024

Conversation

jafermarq
Copy link
Contributor

A very much needed refresh to this docs page

wip
@jafermarq jafermarq added documentation Improvements or additions to documentation simulation An issue related to Flower's simulation labels Nov 14, 2024
jafermarq and others added 5 commits November 14, 2024 18:08
wip

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@jafermarq jafermarq marked this pull request as ready for review November 15, 2024 14:55
Copy link
Contributor

@chongshenng chongshenng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jafermarq Thanks for this, it's a very nice and timely update! I've a few comments and some nits.

doc/source/how-to-run-simulations.rst Outdated Show resolved Hide resolved
doc/source/how-to-run-simulations.rst Outdated Show resolved Hide resolved
doc/source/how-to-run-simulations.rst Outdated Show resolved Hide resolved
doc/source/how-to-run-simulations.rst Outdated Show resolved Hide resolved
doc/source/how-to-run-simulations.rst Outdated Show resolved Hide resolved
doc/source/how-to-run-simulations.rst Outdated Show resolved Hide resolved
doc/source/how-to-run-simulations.rst Outdated Show resolved Hide resolved
doc/source/how-to-run-simulations.rst Show resolved Hide resolved
User ``ray status`` to check all nodes connected to your head node as well as the total
resources available to the ``VirtualClientEngine``.
FAQ for Simulations
-------------------
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a FAQ here about running simulations on multiple machines. This is a question I've seen a few times. We can then link it to your explanation above, where we call it multi-node.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about also adding an FAQ about tracking results from simulations?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you mean by "tracking results" here?

doc/source/how-to-run-simulations.rst Outdated Show resolved Hide resolved
jafermarq and others added 6 commits November 15, 2024 22:03

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Co-authored-by: Chong Shen Ng <chong.shen@flower.ai>

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@danieljanes danieljanes enabled auto-merge (squash) November 17, 2024 11:05
@danieljanes danieljanes merged commit 9cdf784 into main Nov 17, 2024
55 checks passed
@danieljanes danieljanes deleted the update-simulation-docs branch November 17, 2024 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation simulation An issue related to Flower's simulation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants