ContextQMD
Back to Predictionio

Submitting a Template to Template Gallery

docs/manual/source/community/submit-template.html.md

0.14.02.9 KB
Original Source
<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

Template Guidelines

  • Please give your template and GitHub repo a meaningful name (for example, My-MLlibKMeansClustering-Template).

  • Please tag your repo for each released version. This is required by Template Gallery.

    For example, tag the release with v0.1.0:

    $ git tag -a v0.1.0 -m 'version 0.1.0'

  • For clarity, the engine template directory structure should be:

    data/  # contains sample data or related files
project/  # contains the necessary sbt files for build (e.g assembly.sbt)
src/  # template source code
.gitignore
README.md
build.sbt
engine.json # one or more engine.json
template.json

  • Try to keep the root directory clean. If you have additional script files or other files, please create new folders for them and provide description.

  • Include a QuickStart of how to use the engine, including:

    1. Overview description of the template
    2. Events and Data required by the template
    3. Description of Query and PredictedResult
    4. Steps to import sample data
    5. Description of the sample data
    6. Steps to build, train and deploy the engine
    7. Steps to send sample query and expected output

  • If you have additional sample data, please also provide description and how to import them in README

  • If you have multiple engine.json files, please provide description of them in README

  • It's recommended to follow Scala Style Guide

How to submit

  • Fork repository
  • Modify docs/manual/source/gallery/templates.yaml introducing a new template. The schema of the engine description is following:
yml
- template:
    name: (Name of your template)
    repo: (Link to your repository)
    description: |-
      (Brief description of your template written in markdown syntax)
    tags: [ (One of [classification, regression, unsupervised, recommender, nlp, other]) ]
    type: (Parallel or Local)
    language: (Language)
    license: (License)
    status: (e.g. alpha, stable or requested (under development))
    pio_min_version: (Minimum version of PredictionIO to run your template)
  • Submit your changes via pull-request