Feature/SK-972 | Suggested changes to quick start guide #691
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
benjaminastrand
commented
Sep 2, 2024
benjaminastrand
commented
- Explain that git clone is only necessary to get the example code if it wasn't already used in the previous step.
- Changed some step-by-step instructions to numbered lists instead of 'löpande' text.
- Clarify that sessions shouldn't be started immediately after uploading package and seed files.
- Clarify how to select a dataset partition for a client when creating several clients.
- Changed the model overview image to include only 5 rounds, as default settings are recommended in the tutorial.
- Fixed minor typos.
github-actions
bot
added
minor
feature
ahellander
reviewed
Sep 2, 2024
docs/quickstart.rst
Outdated
| In the Studio UI, navigate to the project you created in step one and click on the "Sessions" tab. Click on the "New Session" button. Under the "Compute package" tab, select a name and upload the generated package file. Under the "Seed model" tab, upload the generated seed file: | ||
| The next step is to initialize the server side with the client code and the initial global model. In the Studio UI, | ||
|
|
||
| 1. Navigate to the project you created in step 1 and click on the "Sessions" tab. |
There was a problem hiding this comment.
Will this format as an itemized list when built with sphinx?
There was a problem hiding this comment.
Yes. However, I changed it to the recommended syntax using '#.' for ordered lists.
docs/quickstart.rst
Outdated
| Go to the Clients' tab and click 'Connect client'. Download a client configuration file and save it to the root of the ``examples/mnist-pytorch folder``. | ||
| Rename the file to 'client.yaml'. | ||
|
|
||
| 1. Go to the 'Clients' tab and click 'Connect client'. |
docs/quickstart.rst
Outdated
| In Studio click on the "Sessions" link, then the "New session" button in the upper right corner. Click the "Start session" tab and enter your desirable settings (the default settings are good for this example) and hit the "Start run" button. | ||
| In Studio, | ||
|
|
||
| 1. Click on the "Sessions" link, then the "New session" button in the upper right corner. |
ahellander
approved these changes
Sep 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.