Updating Client and DataSet docs #410
Conversation
…cript_multiGPU (#407) * pushing initial changes * changes to func and tests * updating changelog * adding type check * pushing for bills comments * pushing revert to old test and adding multigpu t * pushing bill chnages * pushing 4 Bills review * pushing for github actions * pushing for pylint * remove trailing white spaces --------- Co-authored-by: Amanda Richardson <[email protected]> Co-authored-by: Amanda Richardson <[email protected]>
amandarichardsonn
changed the title
| @@ -2,22 +2,24 @@ | |||
| Data Structures | |||
| *************** | |||
|
|
|||
| RedisAI defines three new data structures to be | |||
There was a problem hiding this comment.
You could move those quick summaries of the client and dataset to the top of this file and then go into more detail below
There was a problem hiding this comment.
Hmmmm I could but then the client API definition would seem a little out of place I feel, what are your thoughts on me describing what a client is? somewhere else in the documentation... like under the smartredis tab?
There was a problem hiding this comment.
but also this tab is discussing the data structures we offer and not about the API's
There was a problem hiding this comment.
but it def wouldnt hurt to have the api defs at the top here tbh - i can adapt it to be like data structures work with which api and if they r in mem or not - r these ds sent to the db or something like that, thoughts on that?
There was a problem hiding this comment.
Hmm. It sounds like what we really need is an API overview page that talks about what the individual pieces of the API are and then links to the pages for them. I can help you set that up
| a PyDataset object | ||
| """Initialize a Dataset object from a PyDataset object | ||
|
|
||
| Create a new Dataset object using the data and properties |
There was a problem hiding this comment.
Keep text left-justified with block above
There was a problem hiding this comment.
The tab tells the rst file to make an indent note, the have this format like below, thoughts?
Add support for Multiple Databases in SmartRedis. This involves a Client class constructor update -- the type of database is now stored in an environment variable rather than being passed in to the Client constructor. The legacy constructor will remain supported for the short term but will be phased out in favor of the new constructor. Updated all test cases and examples with the new Client class constructor. Updated documentation. [ committed by @billschereriii ] [ reviewed by @ashao @MattToast ]
Run examples on commit to keep them fresh [ committed by @billschereriii ] [ reviewed by @ashao ]
* pushing PR up for review * pushing edits to dataset name retrival * pushing bill comments * adding to docs
This PR will merge edits to the SmartRedis Cray docs to make more clear the functionality between the DataSet API and the Client API