Skip to content

[WIP] Extend trainedmodel doc#117

Draft
KonstantinWilleke wants to merge 15 commits intosinzlab:masterfrom
KonstantinWilleke:extend_trainedmodel_doc
Draft

[WIP] Extend trainedmodel doc#117
KonstantinWilleke wants to merge 15 commits intosinzlab:masterfrom
KonstantinWilleke:extend_trainedmodel_doc

Conversation

@KonstantinWilleke
Copy link
Copy Markdown
Collaborator

The docstring now includes an example Instantiation and elaborates on the use of the dj.stores and the minio.

Comment thread nnfabrik/templates/trained_model.py Outdated
>>> from nnfabrik.main import my_nnfabrik
>>> from nnfabrik.templates import TrainedModelBase
>>> my_nnfabrik_module = my_nnfabrik('nnfabrik_schema_name')
>>> @schema
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't that be @my_nnfabrik_module.schema?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yes, you are completely right. Fixing it now

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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@KonstantinWilleke KonstantinWilleke changed the title Extend trainedmodel doc [WIP] Extend trainedmodel doc Sep 23, 2021
@KonstantinWilleke KonstantinWilleke marked this pull request as draft September 23, 2021 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants