Add/documentation #237
Open
Add/documentation #237
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment on lines
+221
to
+222
| The `PymiloServer` class facilitates streaming machine learning models over a network. | ||
|
|
There was a problem hiding this comment.
It's good to have a short description of how the methods, element below are used as paratmers for the server
|
|
||
| #### PymiloClient | ||
|
|
||
| The `PymiloClient` class facilitates working with remote PyMilo servers. |
Comment on lines
+272
to
+275
| | **Mode** | **Description** | | ||
| | -------- | --------------- | | ||
| | LOCAL | Execute operations on the local model | | ||
| | DELEGATE | Delegate operations to the remote server | |
There was a problem hiding this comment.
Turn this into a text description, the format used here is different from other place and it can be confusing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
Add API Reference of main user facing classes of PyMilo.
I tried to follow the structure we have chosen for Memor.
What does this implement/fix? Explain your changes.
Any other comments?