Adds backend / SDK dev doc #262
Conversation
nickyfantasy
requested review from
Superjomn,
cs2be,
varunarora,
jetfuel and
daming-lu
| Any code changes in ```server``` folder, simply run | ||
|
|
||
| ``` | ||
| python visualdl/server/visualDL --logdir={LOG_DIR} --port=8080 |
There was a problem hiding this comment.
So I had a problem on this step wherein it was importing libraries from the pip installed version of visualDL. So I had to resolve it by resetting my PYTHONPATH. You don't need to explain it as much as it would be nice if it is mentioned in a comment.
There was a problem hiding this comment.
ya, I run into same issue, let me update
docs/how_to_dev_backend_en.md
Outdated
|
|
||
| #### Information Container | ||
| - Currently it just handles logic of sync cycle (when to write) | ||
| - In future we may add logic of when to read |
There was a problem hiding this comment.
When to read needn't be synced or controlled, because the R/W conflicts happen rarely, and the web service can be retriggered a few times, that is a cheap but relatively not bad way to assure read service reliability.
The read service should not affect the writing service, that is the key.
docs/how_to_dev_backend_en.md
Outdated
| - ```Record``` : represent any data structure for any component | ||
| - Handles the actual logic to serialized to disk and deserialized from disk | ||
| - ```storage.proto```: protobuf file that defines the exact interface to be read/write | ||
|
|
There was a problem hiding this comment.
remove the empty line in the tail.
No description provided.