document batching

[aniketmaurya]

Before submitting

• Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
• Did you read the contributor guideline, Pull Request section?
• Did you make sure to update the docs?
• Did you write any new necessary tests?

What does this PR do?

Fixes # (issue).

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in GitHub issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82%. Comparing base (6906a5d) to head (4f368fa).

Additional details and impacted files

@@        Coverage Diff         @@
##           main   #65   +/-   ##
==================================
  Coverage    82%   82%           
==================================
  Files         6     6           
  Lines       439   439           
==================================
  Hits        361   361           
  Misses       78    78           

[lantiga]

Great, added comments

[lantiga]

Looks good, but I think the examples would benefit a lot from an example request and response, so you have a better understanding of what to expect

[aniketmaurya]

Looks good, but I think the examples would benefit a lot from an example request and response, so you have a better understanding of what to expect

@lantiga did you mean to have a full example instead of the ... as follows?

class SimpleStreamAPI(ls.LitAPI):
    # add encode_response and decode_response here as well
    ...

    def batch(self, inputs):
        return np.stack(inputs)

    def unbatch(self, output):
        return list(output)

    ...

[lantiga]

No I mean what the input and output data payloads look like for each case (especially for batching).

Let's keep it for a separate enhancement, just resolve the conflict for now and we merge.