Template repository as base to create a new model that can be plugged into modelhub.ai
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
contrib_src Added info about generating UIDs Aug 8, 2018
init Added explanation on how to fill in the template Jul 25, 2018
README.md Update README.md Aug 10, 2018

README.md

Model Template

Template repository as base to create a new model that can be plugged into modelhub.ai.

How to use this template to contribute your model to modelhub.ai

Fork this repository and rename it. Choose a name that apropriately describes your model in a conciese way.

Fill in the template files and folders with your code, model, and sample data.

To publish your model with modelhub.ai, clone https://github.com/modelhub-ai/modelhub, add your model to the model index list "models.json", and create a pull request. If your model passes our basic tests, we will accept the pull requst and your model will be available via modelhub.ai.

For a more detailed guide on how to contribute your model to modelhub, see Contribute Your Own Model to Modelhub in the offical Modelhub Documentation.

License

We release the code of this model-template repository (https://github.com/modelhub-ai/model-template) under the UNLICENSE (see full text below). We do this so you can fork and use this template as basis for your own models, and release them under any license you want, without restrictions and without even giving credit to modelhub.ai (we're happy if you do so anyway, of course). To be clear: You can completely remove the UNLICENSE from your fork/copy of this repository and instead add any license you like!

After you forked (and renamed) this repository we advice you to immediately delete the README.md file (or at least any text herein regarding licensing - you don't want the UNLICENSE to lurk around when you are intending to release your model under a different license). Then add the licence you want to use for your models into the "contrib_src/license/model" file. Also add the license and copyright notice for your sample data to the "contrib_src/license/samples" file. If you want to add the model to the modelhub.ai model collection, you of course have to make sure, that your license allows modelhub.ai to use your model.

The UNLICENSE for the model-template repository (https://github.com/modelhub-ai/model-template):

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org