Skip to content

Refactor or update present documentation pages #17

@ShamsUlAzeem

Description

@ShamsUlAzeem

Based on Alex's review:

Page: https://serving.oss.konduit.ai/

  • IMO we need a diagram (flow chart) here showing pipeline steps, with logos - TF, ONNX, PMML, DL4J, Python, Java etc. Maybe Numpy, Arrow, CUDA etc.
    • First page is only text ATM; explaining it visually too should help users to more quickly understand what it and why they should care
  • Clarify what PMML means in practice - i.e., "can be used to serve models from libraries X, Y and Z (using built-in conversion)"
  • Maybe mention also Java as an option for pipeline steps (1 line after datavec but before usage probably)

Page: https://serving.oss.konduit.ai/quickstart/quickstart-python

  • Is it possible to define the configuration programmatically, instead of via a YAML file? If so, we should show this first/too
  • A list of API methods on the server and client would be nice. I see server.start(), client.predict() - let's get the full list in a table perhaps?

Page: https://serving.oss.konduit.ai/installation

  • Mentions CUDA 10.1. But TF <2.1.0 is CUDA 10.0, so not correct? (>=2.1.0 is 10.1)
  • Clarify that PMML doesn't support CUDA
  • Do I need to have CUDA installed? CUDNN?
  • "Ensure that you have JDK 8.0 installed"
    • This should probably be 8.0 or higher
    • Do we need a link on how get Java? (I'm just thinking for Python devs who have never touched Java before)

Page: https://serving.oss.konduit.ai/building-from-source

  • Clarify at the very top: When does / doesn't the user need this? If they don't need it, what's the easier alternative?
  • There's lots of different modules here... as a user/developer, how do I decide which ones I need? Table, diagram, and/or flow chart etc?
  • "Python bundling is not encouraged on ARM platforms" - that's vague. Why? Is it unstable? Broken? Limited?
  • "> konduit init --os " - is cross-compilation possible? - i.e., say I want to build on mac but deyloy on Linux+CUDA (clarify either way)
  • "Known issues - konduit init fails for linux-86_64-gpu (#115)" - issue is already closed.

Page: https://serving.oss.konduit.ai/yaml-configurations

  • Clarify what "NDARRAY" type actually means. Is this NumPy format?

Page: https://serving.oss.konduit.ai/model-monitoring/monitoring-grafana

  • "...to assist with troubleshooting" -> mention monitoring and debugging; it's not just (or even primarily) about problems
  • Maybe a better example image of the pipeline charts would be good, so it's a bit more appealing to users?

Page: https://serving.oss.konduit.ai/examples/python/tensorflow-model-serving/tf-bert

  • "This notebook illustrates..." -> it's a page, not a notebook

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions