[WIP] Extend trainedmodel doc#117
Draft
KonstantinWilleke wants to merge 15 commits intosinzlab:masterfrom
Draft
Conversation
update master
update master
update master
update master
update master
update master
update master
update master
update master
MaxFBurg
reviewed
Mar 5, 2021
| >>> from nnfabrik.main import my_nnfabrik | ||
| >>> from nnfabrik.templates import TrainedModelBase | ||
| >>> my_nnfabrik_module = my_nnfabrik('nnfabrik_schema_name') | ||
| >>> @schema |
Member
There was a problem hiding this comment.
Shouldn't that be @my_nnfabrik_module.schema?
Collaborator
Author
There was a problem hiding this comment.
Oh yes, you are completely right. Fixing it now
eywalker
reviewed
Mar 5, 2021
| value of `nnfabrik` to a module or "core" as stated above, and specifically override a target table | ||
| via setting one of the table class property as well. | ||
| * The TrainedModel table also needs a storage defined within the dj.config. | ||
| By default, this storage is called "minio", and is set by this template accordingly. |
Member
There was a problem hiding this comment.
I like the explanation for setting up the storage, but I feel this ought to belong not in doc for TrainedModelBase but preferably somewhere closer to the doc's top level with its section. You can then refer to it from here.
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
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.
The docstring now includes an example Instantiation and elaborates on the use of the
dj.storesand theminio.