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

Revamp StartupPage Readme #919

Closed

Conversation

nammbash
Copy link
Collaborator

@nammbash nammbash commented Feb 1, 2024

Type of Change

Documentation

Description

The Startup Page readme documentation revamped for faster adoption for developers.
Changes include the following:

  1. Edits to formats.
  2. Adding tabular format for different API with feature support.
  3. Adding Quick start guide using TaskRunner API

Expected Behavior & Potential Risk

Change shouldn't affect any code and should pose no risk.

How has this PR been tested?

Local tested on ICX server.

Dependency Change?
None.

@nammbash nammbash requested review from psfoley, kta-intel, SprashAI and manuelhsantana and removed request for SprashAI February 1, 2024 19:12
@ifahim
Copy link
Collaborator

ifahim commented Feb 7, 2024

  1. What is FQDN? Write Full name before using the acronym

  2. There should be no spaces in the following command: no_proxy=localhost,10.x.x.x,

  3. In setup miniconda, is only python 3.10 supported?

  4. What is " WORKSPACE_TEMPLATE=keras_cnn_mnist"? why it is needed? What is "FL Plan"

  5. is there a way to remember the settings? or have a bash file to run? I got disconnected and the entire settings are gone. So I have to do it again.

  6. Error: Invalid value for '-i' / '--import': Path 'agg_to_col_cob_1_signed_cert.zip' does not exist.

  7. Running the federation gives error: The collaborators unable to connect to the aggregator. The error is as under:
    .[23:16:57] INFO Response code: StatusCode.UNAVAILABLE aggregator_client.py:59
    INFO Attempting to connect to aggregator at 984fee019b88.jf.intel.com:59549 aggregator_client.py:33

  8. How the expected output looks like ?

@ifahim
Copy link
Collaborator

ifahim commented Feb 7, 2024

@nammbash please see my comments. thanks

@ifahim
Copy link
Collaborator

ifahim commented Feb 7, 2024

Looks good to me. I was able to run end to end. Thanks

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@nammbash
Copy link
Collaborator Author

@psfoley @kta-intel @manuelhsantana @ifahim Requesting re-review of the readme startup documentation.
Reduced steps and added expected output.

@nammbash nammbash requested a review from ifahim February 24, 2024 03:35
@nammbash nammbash force-pushed the startuppagereadme branch 6 times, most recently from c02b70c to 67db64e Compare February 29, 2024 20:25
Copy link
Collaborator

@kta-intel kta-intel left a comment

Choose a reason for hiding this comment

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

Great job, Niroop! The updated quick start guide is very clear and easy to follow. I especially like the sample output. I only have two minor fixes, but other than that, this looks good to me

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@nammbash nammbash closed this Mar 1, 2024
@nammbash nammbash force-pushed the startuppagereadme branch from 24c140a to 02076b3 Compare March 1, 2024 03:26
@nammbash nammbash reopened this Mar 1, 2024
@nammbash nammbash force-pushed the startuppagereadme branch from 15f2717 to 17c86fd Compare March 1, 2024 03:38
Update README.md with new FL Plan Link

Signed-off-by: nammbash <[email protected]>
@nammbash nammbash force-pushed the startuppagereadme branch from 3d6a336 to 86995a3 Compare March 1, 2024 03:50
@nammbash
Copy link
Collaborator Author

nammbash commented Mar 1, 2024

looks like there was a major merge to the develop branch. So I rebased, remade this PR to remove conflicts @psfoley @kta-intel @manuelhsantana

@kta-intel kta-intel self-requested a review March 1, 2024 20:54
@psfoley psfoley closed this Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants