Add storage specification to BaseStorage class doc.#1174
Merged
hvy merged 5 commits intooptuna:masterfrom May 12, 2020
Merged
Conversation
20 tasks
Codecov Report
@@ Coverage Diff @@
## master #1174 +/- ##
==========================================
- Coverage 91.04% 91.02% -0.02%
==========================================
Files 142 142
Lines 12255 12276 +21
==========================================
+ Hits 11157 11174 +17
- Misses 1098 1102 +4
Continue to review full report at Codecov.
|
hvy
reviewed
Apr 30, 2020
Member
hvy
left a comment
There was a problem hiding this comment.
Content LGTM. Some thoughts and questions.
- It's a lot of content. Grouping into sections might make it easier to comprehend and maintain. For instance, monotinic-reads and read-your-writes could have its own section. Other groupings might be less straight forward, though.
- It might be a bit confusing since
loadisn't yet introduced. How about adding a TODO. - Are you imagining this specification to sort of grow to be more specific in on the coming days/weeks while addressing #1170. I'm curious about the intended level of detail.
Member
Author
|
Thank you for checking the doc.
|
sile
approved these changes
May 8, 2020
Member
sile
left a comment
There was a problem hiding this comment.
LGTM! Thank you for the great work!
|
|
||
| **Stronger consistency requirements for special data** | ||
|
|
||
| TODO(ytsmiling) Add load method to storage class implementations. |
Member
There was a problem hiding this comment.
[NOTE] I'd like to discuss the name when this method is implemented (load sounds too general to me).
Member
Author
There was a problem hiding this comment.
I agree with this comment. I added a TODO comment in #1170.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Motivation
As noted in #1170, defining consistency models let storage implementations to remove their bottlenecks.
Description of the changes.
This PR adds a class doc to
BaseStorageclass which defines consistency models which storage classes should guarantee. Additionally, it also notes on thread-safety and data-persistence.This PR introduces
load(study_id)method. It is not supported by the current implementation and will be added by successive PRs. The method is not only required to reduce the sync cost with a remote database, but also necessary to alleviate the problem described in #1166 in multi-worker settings.