search

intel-analytics / analytics-zoo

Distributed Tensorflow, Keras and PyTorch on Apache Spark/Flink & Ray
https://analytics-zoo.readthedocs.io/
Apache License 2.0
17 stars 4 forks source link

Analytics Zoo full stack manual/guide demand #881

Open renerj opened 4 years ago

renerj commented 4 years ago

Issue: Need full stack Analytics Zoo Manual to support user build Analytics Zoo based AI platform. Background :

  1. Current guides are linked with each function and located in different folders in Github. Users are harder to base that to understand whole Analytics Zoo major functions
  2. Installation guides do not work well as expected, still need waste engineer resource to support customer deploy
  3. Lack of information to let user know how to verify they already successfully deploy Analytics Zoo and major functions works well as expected. Support needed Need one full stack manual/guide to integrate current separate located links to
  4. let user have overall picture for Analytics Zoo major functions
  5. Support user to finish setup and understand how verify setup is done
  6. Support user to verify Analytics Zoo major functions
Wesley-Du commented 4 years ago

========== reorganize the issue statement ========== Background :

  1. Current guides are linked with each function and located in different folders in Github. Users are harder to base that to understand whole Analytics Zoo major functions.
  2. Installation guides do not work well as expected, still need waste engineer resource to support customer deploy
  3. Lack of information to let user know how to verify they already successfully deploy Analytics Zoo and major functions works well as expected.

Support needed:

  1. Need one full stack manual/guide to integrate current separate located links to let user have overall picture for Analytics Zoo major functions
  2. Support user to finish setup and understand how verify setup is done
  3. Support user to verify Analytics Zoo major functions
Wesley-Du commented 4 years ago

Please help clarify:

  1. I would assume users are asking to continue use the analytics-zoo.github.io to improve the existing document. It's not to ask for new standalone manual like pdf file?

  2. It sounds like customers asks for two parts in the new "manual": Part 1: a centralized place for all the links for the major zoo components/functions. Part 2: a better installation guide, which help customers to set up zoo more easily. The installation guide need to provide method for user to verify if the installation are successful, and provide method for user to verify if the major features works.

Please confirm if this is the requirement.

  1. For the feedback "Installation guides do not work well as expected, still need waste engineer resource to support customer deploy", can the feedback be more specific, for example, if the guides contains incorrect information, or steps not complete, or document quality issue (wording, organize issue etc). Need to knowing what is not working so we know how to improve the current installation guide.
jason-dai commented 4 years ago

I think we will still use analytics-zoo.github.io

For installation, we can use docker to help user get started on single node; we may need to improve the guide for cluster environment, as well as Python (pip, conda, etc.) and scala (maven, sbt, etc.) later.

After installation, we will need a guide for user to run different examples depending which features/topics they are interested in.

I think we should also add a getting started page, like https://bigdl-project.github.io/0.10.0/#getting-started/