Add user docs for Turing/Turing SDK

[deadlycoconuts]

In PR #164, PR #165, PR #170 and PR #171, an automated pyfunc ensembler building feature was introduced for Turing. This PR introduces a small section to guide users on how this feature can be used when deploying routers via the UI.

In addition, this PR also adds new documentation for router deployment using Turing SDK, which was introduced in PR #148, PR #152, PR #155.

Additions

• docs/* - Addition of pyfunc ensembler deployment using Turing UI
• sdk/docs/* - Addition of new documentation for router deployment using Turing SDK

Fixes

• Tiny code cleanup to Turing SDK

[krithika369]

Hi @deadlycoconuts, left some comments on the contents of the docs. They look great - thanks for the extensive documentation!

I have one question - how will these multi-file .md docs be published to Pypi? I think that typically, only one file may be included as a README (ref), in one of the supported formats, of which .md is one. If we have multiple .md files, they need to be combined somehow. Have you already explored this?

Also, setup.py needs to be updated to include the doc when packaging and publishing to Pypi.

[krithika369]

The key of the dict is the route name, correct? (would help to state that explicitly)

[deadlycoconuts]

Actually the route responses will get returned as a List. Each element corresponds to a route response, which itself is a Dict which has the schema:

{
  "route": // ... Route name,
  "data": {
    // ... Successful route response
  },
  "is_default": // ... Boolean value
}

I suppose you were wondering if the underlying implementation of the pyfunc ensembler engine helps transform the raw route responses into something more intuitive, i.e. a Dict with key-value pairs where the key's a route name and the value's the route response. In this case the answer's no because I thought preserving the original request schema would be most easily understood by users (this would be how a user would expect a request if he/she was building a Docker ensembler), but that said, we can also implement the transformation in the engine if you think it's more intuitive for users.

[krithika369]

Based on the recent discussions, my suggestion would be to:

• Keep the sdk/docs/README.md as is (the image URL may need to be replaced with a public one, from Github later on, so Pypi can read from it)
• Update the SDK samples, if required, with more comments (like what you've added for some of the how-to docs) / examples on the SDK usage (especially the Pyfunc real-time ensembler)
• Drop the other how-to docs and handle the Sphinx to RTD in a separate task / PR later on.

[deadlycoconuts]

Added a new file to demonstrate the deployment of a router with a pyfunc ensembler.

[krithika369]

Left a couple of minor comments. Looks great otherwise. Thanks, @deadlycoconuts !

[deadlycoconuts]

Thanks a lot for the thoughtful comments @krithika369 ! I'll be merging this! 🚀