oldfly closed pull request #1: [MARVIN-16] Marvin-AI Website Initialization URL: https://github.com/apache/incubator-marvin-website/pull/1
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/site/_config.yml b/site/_config.yml index 6fd56af..1f61e15 100644 --- a/site/_config.yml +++ b/site/_config.yml @@ -17,7 +17,7 @@ markdown: kramdown permalink: /news/:year/:month/:day/:title/ excerpt_separator: "" -repository: https://github.com/apache/apache-website-template +repository: https://github.com/apache/incubator-marvin-website destination: target exclude: [README.md,Gemfile*] keep_files: [".git", ".svn", "apidocs"] diff --git a/site/_data/contributors.yml b/site/_data/contributors.yml index 8454a3b..304159d 100644 --- a/site/_data/contributors.yml +++ b/site/_data/contributors.yml @@ -17,34 +17,52 @@ # Pages such as community.md use this data. # Please keep the list in alphabetical order. # -- name: DB Tsai - apacheId: dbtsai - githubId: dbtsai + +- name: Daniel Martins Takabayashi + apacheId: taka + githubId: takabayashi + org: B2W Digital + role: PMC + +- name: Yifei Zhang + apacheId: yifeizhang + githubId: oldfly + org: + role: PMC + +- name: Lucas Bonatto Miguel + apacheId: lucasbm88 + githubId: lucasbm88 + org: role: PMC - org: Netflix -- name: Julian Hyde - apacheId: jhyde - githubId: julianhyde - org: Hortonworks +- name: Rafael Novello + apacheId: rafaelnovello + githubId: rafaelnovello + org: + role: PMC + +- name: Wei Chen + apacheId: Wei-1 + githubId: Wei-1 + org: Change Healthcare role: Contributor - homepage: http://people.apache.org/~jhyde - name: Luciano Resende apacheId: lresende githubId: lresende org: IBM - role: Committer and Mentor + role: Mentor -- name: Reynold Xin - apacheId: rxin - githubId: rxin - org: Databricks - role: Committer and Mentor +- name: Jim Jagielski + apacheId: jimjag + githubId: jimjag + org: + role: Mentor -- name: Rich Bowen - apacheId: rbowen - githubId: rbowen +- name: William Colen + apacheId: wcolen + githubId: wcolen org: role: Mentor diff --git a/site/_data/project.yml b/site/_data/project.yml index b2d0cfd..8d27ae4 100644 --- a/site/_data/project.yml +++ b/site/_data/project.yml @@ -15,20 +15,20 @@ # # Apache Project configurations # -name: Apache SystemML -short_name: SystemML -unix_name: systemml -incubator_name: incubator-systemml -incubator_slash_name: incubator/systemml -description: Apache SystemML is a distributed and declarative machine learning platform. - -download: /download.html - -dev_list: [email protected] -dev_list_subscribe: [email protected] -dev_list_unsubscribe: [email protected] -dev_list_archive: http://mail-archives.apache.org/mod_mbox/systemml-dev/ -dev_list_archive_mailarchive: https://www.mail-archive.com/[email protected]/ +name: Apache MarvinAI +short_name: MarvinAI +unix_name: MarvinAI +incubator_name: incubator-marvin +incubator_slash_name: incubator/marvin +description: Apache MarvinAI is a platform for machine learning operations (ML-Ops) + +download: /marvin-platform-book/ch2_toolbox_installation/overview + +dev_list: [email protected] +dev_list_subscribe: [email protected] +dev_list_unsubscribe: [email protected] +dev_list_archive: http://mail-archives.apache.org/mod_mbox/marvin-dev/ +dev_list_archive_mailarchive: https://www.mail-archive.com/[email protected]/ dev_list_archive_markmail: user_list: @@ -38,19 +38,19 @@ user_list_archive: user_list_archive_mailarchive: user_list_archive_markmail: -commits_list: [email protected] -commits_list_subscribe: [email protected] -commits_list_unsubscribe: [email protected] -commits_list_archive: http://mail-archives.apache.org/mod_mbox/systemml-commits/ -commits_list_archive_mailarchive: https://www.mail-archive.com/[email protected]/ +commits_list: [email protected] +commits_list_subscribe: [email protected] +commits_list_unsubscribe: [email protected] +commits_list_archive: http://mail-archives.apache.org/mod_mbox/marvin-commits/ +commits_list_archive_mailarchive: https://www.mail-archive.com/[email protected]/ commits_list_archive_markmail: -jira: SYSTEMML +jira: MARVINAI -source_repository: https://git-wip-us.apache.org/repos/asf/incubator-systemml.git -source_repository_mirror: https://github.com/apache/incubator-systemml +source_repository: https://gitbox.apache.org/repos/asf/incubator-marvin.git +source_repository_mirror: https://github.com/apache/incubator-marvin -website_repository: https://git-wip-us.apache.org/repos/asf/incubator-systemml-website.git -website_repository_mirror: https://github.com/apache/incubator-systemml-website +website_repository: https://gitbox.apache.org/repos/asf/incubator-marvin-website.git +website_repository_mirror: https://github.com/apache/incubator-marvin-website podling: true \ No newline at end of file diff --git a/site/_includes/themes/apache/_navigation.html b/site/_includes/themes/apache/_navigation.html index 786e96b..5595a03 100644 --- a/site/_includes/themes/apache/_navigation.html +++ b/site/_includes/themes/apache/_navigation.html @@ -7,9 +7,8 @@ <span class="icon-bar"></span> <span class="icon-bar"></span> </button> - <a class="navbar-brand" href="{{ BASE_PATH }}"> - <img src="/assets/themes/apache/img/logo.png" width="50"> - {{ site.data.project.name }} + <a class="navbar-brand" href="/"> + <img src="/assets/themes/apache/img/logo.png" width="80"> </a> </div> <nav class="navbar-collapse collapse" role="navigation"> @@ -21,7 +20,8 @@ <li><a href="/community-members">Who we are</a></li> </ul> </li> - <li><a href="{{ site.data.project.source_repository }}">GitHub</a></li> + <li><a href="/marvin-platform-book/SUMMARY">Document</a></li> + <li><a href="{{ site.data.project.source_repository_mirror }}">GitHub</a></li> <li id="apache"> <a href="#" data-toggle="dropdown" class="dropdown-toggle">Apache<b class="caret"></b></a> <ul class="dropdown-menu"> diff --git a/site/assets/themes/apache/img/logo.png b/site/assets/themes/apache/img/logo.png index 0b45fa4..fc991c6 100644 Binary files a/site/assets/themes/apache/img/logo.png and b/site/assets/themes/apache/img/logo.png differ diff --git a/site/community-members.md b/site/community-members.md index 4edf3ae..936b489 100644 --- a/site/community-members.md +++ b/site/community-members.md @@ -33,17 +33,14 @@ limitations under the License. <table class="table table-hover"> <tr> <th><b></b></th><th><b>Full Name</b></th><th><b>Apache ID</b></th><th><b>GitHub</b><th><b>Role</b></th><th><b>Affiliation</b></th> - </tr> {% for member in site.data.contributors %} - <tr> + <tr> <td><a href="http://github.com/{{ member.githubId }}"><img width="64" src="{% unless c.avatar %}http://github.com/{{ member.githubId }}.png{% else %}{{ member.avatar }}{% endunless %}"></a></td> <td>{{member.name}}</td> <td>{{member.apacheId}}</td> <td><a href="http://github.com/{{ member.githubId }}">{{ member.githubId }}</a></td> <td>{{member.role}}</td> <td>{{member.org}}</td> - </tr> {% endfor %} -</table> {% endif %} diff --git a/site/history.md b/site/history.md index 0b8d55b..0383d28 100644 --- a/site/history.md +++ b/site/history.md @@ -30,7 +30,7 @@ limitations under the License. For a full list of releases, see <a href="https://github.com/apache/{{ site.data.project.incubator_slash_name }}/releases">github</a>. Downloads are available on the -[downloads page]({{ site.baseurl }}/download.html). +[downloads page]({{ site.baseurl }}/marvin-platform-book/ch2_toolbox_installation/overview). ## <a href="https://github.com/apache/{{ site.data.project.incubator_slash_name }}/releases/tag/{{ site.data.project.unix_name }}-0.2.0">0.2.0</a> / 2015-11-10 {: #v0-2-0} diff --git a/site/index.md b/site/index.md index 0d1f178..c377dd5 100644 --- a/site/index.md +++ b/site/index.md @@ -24,14 +24,6 @@ limitations under the License. {% include JB/setup %} -## Apache SystemML +## Apache MarvinAI -SystemML provides declarative large-scale machine learning (ML) that aims at flexible specification -of ML algorithms and automatic generation of hybrid runtime plans ranging from single node, -in-memory computations, to distributed computations on Apache Hadoop and Apache Spark. -ML algorithms are expressed in a R or Python syntax, that includes linear algebra primitives, statistical functions, -and ML-specific constructs. This high-level language significantly increases the productivity of data scientists -as it provides (1) full flexibility in expressing custom analytics, and (2) data independence from the underlying -input formats and physical data representations. Automatic optimization according to data characteristics such as -distribution on the disk file system, and sparsity as well as processing characteristics in the distributed environment -like number of nodes, CPU, memory per node, ensures both efficiency and scalability. +MarvinAI is an open source Artificial Intelligence platform that focus on helping data science team members, in an easy way, to deliver complex solutions supported by a high-scale, low-latency, language agnostic and standardized architecture while simplifying the process of exploitation and modeling. diff --git a/site/marvin-platform-book/GLOSSARY.md b/site/marvin-platform-book/GLOSSARY.md new file mode 100644 index 0000000..5818c4e --- /dev/null +++ b/site/marvin-platform-book/GLOSSARY.md @@ -0,0 +1,33 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +## Term +Definition for this term + +## Another term +With it's definition, this can contain bold text +and all other kinds of inline markup ... \ No newline at end of file diff --git a/site/marvin-platform-book/README.md b/site/marvin-platform-book/README.md new file mode 100644 index 0000000..a66b668 --- /dev/null +++ b/site/marvin-platform-book/README.md @@ -0,0 +1,32 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Overview + +**Marvin** is an open source Artificial Intelligence platform that focus on helping data science team members, in an easy way, to deliver complex solutions supported by a high-scale, low-latency, language agnostic and standardized architecture while simplifying the process of exploitation and modeling. + + \ No newline at end of file diff --git a/site/marvin-platform-book/SUMMARY.md b/site/marvin-platform-book/SUMMARY.md new file mode 100644 index 0000000..a943b3b --- /dev/null +++ b/site/marvin-platform-book/SUMMARY.md @@ -0,0 +1,63 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Summary + +* [Overview](/marvin-platform-book/README) +* [Main Components](/marvin-platform-book/ch1_main_components/overview) + * [DAFSE](/marvin-platform-book/ch1_main_components/dasfe) + * [Toolbox](/marvin-platform-book/ch1_main_components/toolbox) + * [Engine](/marvin-platform-book/ch1_main_components/engine) + * [Engine Executor](/marvin-platform-book/ch1_main_components/engine_executor) + * [Artefacts](/marvin-platform-book/ch1_main_components/artefacts) + * [Marvin Notebook Extension](/marvin-platform-book/ch1_main_components/notebook) +* [Installing Marvin](/marvin-platform-book/ch2_toolbox_installation/overview) + * [Ubuntu (Debian) Installation](/marvin-platform-book/ch2_toolbox_installation/ubuntu) + * [MacOS Installation](/marvin-platform-book/ch2_toolbox_installation/mac) + * [Vagrant Installation](/marvin-platform-book/ch2_toolbox_installation/vagrant) + * [Docker Installation](/marvin-platform-book/ch2_toolbox_installation/docker) +* [Get Started](/marvin-platform-book/ch3_get_started/overview) + * [Creating a New Engine](/marvin-platform-book/ch3_get_started/create_engine) + * [Working in an Existent Engine](/marvin-platform-book/ch3_get_started/existent_engine) + * [Running an Example Engine](/marvin-platform-book/ch3_get_started/engine_examples) + * [Iris Classification Engine](/marvin-platform-book/ch3_get_started/iris_engine) + * [SMS Spam Detector Engine](/marvin-platform-book/ch3_get_started/sms_engine) + * [MNIST Classifier With Keras Engine](/marvin-platform-book/ch3_get_started/mnist_engine) +* [Documentation](/marvin-platform-book/ch4_documentation/overview) + * [Toolbox CLI](/marvin-platform-book/ch4_documentation/toolbox_cli) + * [Engine CLI](/marvin-platform-book/ch4_documentation/engine_cli) + * [Generic Rest API](/marvin-platform-book/ch4_documentation/generic_rest_api) + * [Toolbox Common Library](/marvin-platform-book/ch4_documentation/toolbox_common_lib) + * [Setting Environmental Params](/marvin-platform-book/ch4_documentation/setting_params) +* [Deploying Into Production](/marvin-platform-book/ch5_deploying/overview) + * [Deploying Into Production](/marvin-platform-book/ch5_deploying/deploying) +* [Marvin AI Platform Architecture](/marvin-platform-book/ch6_platform_architecture/overview) +* [Community](/marvin-platform-book/ch7_community/overview) + * [Github](/marvin-platform-book/ch7_community/community#github) + * [Roadmap](/marvin-platform-book/ch7_community/community#roadmap) + * [How to Contribute](/marvin-platform-book/ch7_community/community#how-to-contribute) +* [Versions](/marvin-platform-book/ch8_versions/overview) diff --git a/site/marvin-platform-book/ch1_main_components/artefacts.md b/site/marvin-platform-book/ch1_main_components/artefacts.md new file mode 100644 index 0000000..7441136 --- /dev/null +++ b/site/marvin-platform-book/ch1_main_components/artefacts.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Artefacts + +Datasets and model(s) are shared between Engine Actions, which are persisted and versioned. \ No newline at end of file diff --git a/site/marvin-platform-book/ch1_main_components/dasfe.md b/site/marvin-platform-book/ch1_main_components/dasfe.md new file mode 100644 index 0000000..e59020a --- /dev/null +++ b/site/marvin-platform-book/ch1_main_components/dasfe.md @@ -0,0 +1,37 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# General Overview + +Here are the components + +# DASFE + +The DASFE design pattern stands for Data Acquisition, Selection, Feedback and Evaluation. +In Marvin, the DASFE pattern is represented by the image below. Each box, which we call an Action, holds code written by the user. + + diff --git a/site/marvin-platform-book/ch1_main_components/engine.md b/site/marvin-platform-book/ch1_main_components/engine.md new file mode 100644 index 0000000..386ff4c --- /dev/null +++ b/site/marvin-platform-book/ch1_main_components/engine.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Engine + +The Engine is the Marvin application, the result of user's implementation, including code, datasets(artifacts), models, etc. We have some [engine examples on github](https://github.com/marvin-ai/marvin-public-engines) and you could install them like described in [Running an example engine](ch3_get_started/engine_examples.md) \ No newline at end of file diff --git a/site/marvin-platform-book/ch1_main_components/engine_executor.md b/site/marvin-platform-book/ch1_main_components/engine_executor.md new file mode 100644 index 0000000..a6ad4cf --- /dev/null +++ b/site/marvin-platform-book/ch1_main_components/engine_executor.md @@ -0,0 +1,30 @@ +--- +layout: page +title: engine executor +description: engine executor +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Engine Executor + +The [engine executor](https://github.com/marvin-ai/marvin-engine-executor) is the component responsible for coordinating execution of the steps (Actions) in a Marvin engine. The engine-executor is able to communicate with engines through the gRPC protocol. \ No newline at end of file diff --git a/site/marvin-platform-book/ch1_main_components/notebook.md b/site/marvin-platform-book/ch1_main_components/notebook.md new file mode 100644 index 0000000..ad43307 --- /dev/null +++ b/site/marvin-platform-book/ch1_main_components/notebook.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Marvin Notebook Extension + +In order to facilitate development of the engine, Jupyter Notebook is integrated into Toolbox. The Marvin notebook extension allows the user to write their code in Notebooks and push updates directly to the Actions. \ No newline at end of file diff --git a/site/marvin-platform-book/ch1_main_components/overview.md b/site/marvin-platform-book/ch1_main_components/overview.md new file mode 100644 index 0000000..34fe53c --- /dev/null +++ b/site/marvin-platform-book/ch1_main_components/overview.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# General Overview + +Here we will explain the design pattern for MARVIN AI \ No newline at end of file diff --git a/site/marvin-platform-book/ch1_main_components/toolbox.md b/site/marvin-platform-book/ch1_main_components/toolbox.md new file mode 100644 index 0000000..fce8895 --- /dev/null +++ b/site/marvin-platform-book/ch1_main_components/toolbox.md @@ -0,0 +1,31 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Toolbox + +The toolbox helps the user develop, test, and run their built engine. +There are separate toolboxes for each language. For example, the [Python Toolbox](https://github.com/marvin-ai/marvin-python-toolbox). \ No newline at end of file diff --git a/site/marvin-platform-book/ch2_toolbox_installation/docker.md b/site/marvin-platform-book/ch2_toolbox_installation/docker.md new file mode 100644 index 0000000..0b3085d --- /dev/null +++ b/site/marvin-platform-book/ch2_toolbox_installation/docker.md @@ -0,0 +1,28 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# General Overview Docker \ No newline at end of file diff --git a/site/marvin-platform-book/ch2_toolbox_installation/mac.md b/site/marvin-platform-book/ch2_toolbox_installation/mac.md new file mode 100644 index 0000000..b4ffd7b --- /dev/null +++ b/site/marvin-platform-book/ch2_toolbox_installation/mac.md @@ -0,0 +1,78 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Installing Toolbox as MacOS user + +1. Toolbox will need some OS dependencies +``` +sudo easy_install pip +brew install openssl graphviz +``` + +2. We strongly recommend the use of VirtualEnv and VirtualEnvWrapper +``` +sudo pip install --upgrade pip +sudo pip install virtualenvwrapper --ignore-installed six +``` + +3. Spark installation (**Optional**) +``` +curl https://d3kbcqa49mib13.cloudfront.net/spark-2.1.1-bin-hadoop2.6.tgz -o /tmp/spark-2.1.1-bin-hadoop2.6.tgz +sudo tar -xf /tmp/spark-2.1.1-bin-hadoop2.6.tgz -C /opt/ +sudo ln -s /opt/spark-2.1.1-bin-hadoop2.6 /opt/spark +echo "export SPARK_HOME=/opt/spark" >> $HOME/.bash_profile +``` + +If you do not have /opt directory created, before unpacking spark, run: +``` +sudo mkdir /opt +``` + +4. Marvin uses dafault values for these environment variables, but you can customize them (**Optional**) +``` +echo "export WORKON_HOME=$HOME/.virtualenvs" >> $HOME/.bash_profile +echo "export MARVIN_HOME=$HOME/marvin" >> $HOME/.bash_profile +echo "export MARVIN_DATA_PATH=$HOME/marvin/data" >> $HOME/.bash_profile +echo "source virtualenvwrapper.sh" >> $HOME/.bash_profile +source ~/.bash_profile +``` + +5. Install python-toolbox +``` +mkvirtualenv python-toolbox-env +setvirtualenvproject +pip install marvin-python-toolbox +``` + +6. Test the installation +``` +marvin test +``` + +7. Youtube tutorial + +[](https://www.youtube.com/watch?v=2iljFG9EZ_Q "Python Toolbox Install") \ No newline at end of file diff --git a/site/marvin-platform-book/ch2_toolbox_installation/overview.md b/site/marvin-platform-book/ch2_toolbox_installation/overview.md new file mode 100644 index 0000000..f0c5462 --- /dev/null +++ b/site/marvin-platform-book/ch2_toolbox_installation/overview.md @@ -0,0 +1,31 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# General Overview + +Toolbox can be installed directly in Ubuntu(Debian) Distribution and MacOS, for other operating systems there is installation through Vagrant or Docker. + diff --git a/site/marvin-platform-book/ch2_toolbox_installation/ubuntu.md b/site/marvin-platform-book/ch2_toolbox_installation/ubuntu.md new file mode 100644 index 0000000..eb9115f --- /dev/null +++ b/site/marvin-platform-book/ch2_toolbox_installation/ubuntu.md @@ -0,0 +1,77 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Installing Toolbox as Ubuntu user + +1. Toolbox will need some OS dependencies +``` +sudo apt-get install libsasl2-dev python-pip graphviz -y +``` + +2. We strongly recommend the use of VirtualEnv and VirtualEnvWrapper +``` +sudo pip install --upgrade pip +sudo pip install virtualenvwrapper --ignore-installed six +``` + +3. Spark installation (**Optional**) +``` +curl https://d3kbcqa49mib13.cloudfront.net/spark-2.1.1-bin-hadoop2.6.tgz -o /tmp/spark-2.1.1-bin-hadoop2.6.tgz +sudo tar -xf /tmp/spark-2.1.1-bin-hadoop2.6.tgz -C /opt/ +sudo ln -s /opt/spark-2.1.1-bin-hadoop2.6 /opt/spark +echo "export SPARK_HOME=/opt/spark" >> $HOME/.bash_profile +``` + +If you do not have /opt directory created, before unpacking spark, run: +``` +sudo mkdir /opt +``` + +4. Marvin uses dafault values for these environment variables, but you can customize them (**Optional**) +``` +echo "export WORKON_HOME=$HOME/.virtualenvs" >> $HOME/.bash_profile +echo "export MARVIN_HOME=$HOME/marvin" >> $HOME/.bash_profile +echo "export MARVIN_DATA_PATH=$HOME/marvin/data" >> $HOME/.bash_profile +echo "source virtualenvwrapper.sh" >> $HOME/.bash_profile +source ~/.bash_profile +``` + +5. Install python-toolbox +``` +mkvirtualenv python-toolbox-env +setvirtualenvproject +pip install marvin-python-toolbox +``` + +6. Test the installation +``` +marvin test +``` + +7. Youtube tutorial + +[](https://www.youtube.com/watch?v=2iljFG9EZ_Q "Python Toolbox Install") \ No newline at end of file diff --git a/site/marvin-platform-book/ch2_toolbox_installation/vagrant.md b/site/marvin-platform-book/ch2_toolbox_installation/vagrant.md new file mode 100644 index 0000000..1d49865 --- /dev/null +++ b/site/marvin-platform-book/ch2_toolbox_installation/vagrant.md @@ -0,0 +1,52 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Installing Toolbox using vagrant + +1. Install requirements +- [Virtual box](http://www.virtualbox.org) (Version 5.1 +) +- [Vagrant](http://www.vagrantup.com) (Version 1.9.2 or +) + + +2. Clone repository and start provision +``` +git clone https://github.com/marvin-ai/marvin-vagrant-dev.git +cd marvin-vagrant-dev +``` + +3. Prepare dev (engine creation) box +``` +vagrant up dev +vagrant ssh dev +``` +Wait for provision process and follow interactive configuration script after access the dev box using vagrant ssh command. + +4. The marvin source projects will be on your home folder, to compile and use the marvin toolbox +``` +workon python-toolbox-env +make marvin +``` \ No newline at end of file diff --git a/site/marvin-platform-book/ch3_get_started/create_engine.md b/site/marvin-platform-book/ch3_get_started/create_engine.md new file mode 100644 index 0000000..878651c --- /dev/null +++ b/site/marvin-platform-book/ch3_get_started/create_engine.md @@ -0,0 +1,47 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Creating a new engine +1. To create a new engine +``` +workon python-toolbox-env +marvin engine-generate +``` +Respond the interactive prompt and wait for the engine environment preparation, and don't forget to start dev box before if you are using vagrant. + +2. Test the new engine +``` +workon <new_engine_name>-env +marvin test +``` +3. For more informations +``` +marvin --help +``` +4. Youtube Tutorial + +[](https://www.youtube.com/watch?v=p7yiLh2uLlQ "Creating first engine") diff --git a/site/marvin-platform-book/ch3_get_started/engine_examples.md b/site/marvin-platform-book/ch3_get_started/engine_examples.md new file mode 100644 index 0000000..9c0c67a --- /dev/null +++ b/site/marvin-platform-book/ch3_get_started/engine_examples.md @@ -0,0 +1,44 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Running a example engine +1. Clone example engine from repository +``` +git clone https://github.com/marvin-ai/engines.git +``` +2. Generate a new marvin engine environment for Iris species engine +``` +workon python-toolbox-env +marvin engine-generateenv ../engines/iris-species-engine/ +``` +3. Run the Iris species engine +``` +workon iris-species-engine-env +marvin engine-dryrun +``` + +For more examples: https://github.com/marvin-ai/marvin-public-engines \ No newline at end of file diff --git a/site/marvin-platform-book/ch3_get_started/existent_engine.md b/site/marvin-platform-book/ch3_get_started/existent_engine.md new file mode 100644 index 0000000..4ded9d4 --- /dev/null +++ b/site/marvin-platform-book/ch3_get_started/existent_engine.md @@ -0,0 +1,44 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Working in an existing engine + +1. If you don't have an engine locally, clone one to your local machine + +2. On Python Toolbox environment, set VirtualEnv and get to engine's path +``` +marvin engine-generateenv /path/to/engine/ +workon <engine_name>-env +``` +3. Test your engine +``` +marvin test +``` +4. Bring up the notebook and access it from your browser +``` +marvin notebook +``` \ No newline at end of file diff --git a/site/marvin-platform-book/ch3_get_started/iris_engine.md b/site/marvin-platform-book/ch3_get_started/iris_engine.md new file mode 100644 index 0000000..0f4e348 --- /dev/null +++ b/site/marvin-platform-book/ch3_get_started/iris_engine.md @@ -0,0 +1,120 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Iris Species v0.0.1 + +## Overview + +Iris Species classification engine from Kaggle + + +## Requirements + +_REPLACE: Add here the list of requirements. For example:_ + + - Python 2.7 + - Numpy 1.11.0 or higher + + +## Installation + +_REPLACE: Add here the best way to install this engine + + +## Development + +### Getting started + +First, create a new virtualenv + +``` +mkvirtualenv marvin_iris_species_engine_env +``` + +Now install the development dependencies + +``` +make marvin +``` + +You are now ready to code. + + +### Adding new dependencies + +It\`s very important. All development dependencies should be added to `setup.py`. + +### Running tests + +This project uses *[py.test](http://pytest.org/)* as test runner and *[Tox](https://tox.readthedocs.io)* to manage virtualenvs. + +To run all tests use the following command + +``` +marvin test +``` + +To run specific test + +``` +marvin test tests/test_file.py::TestClass::test_method +``` + + +### Writting documentation + +The project documentation is written using *[Jupyter](http://jupyter.readthedocs.io/)* notebooks. +You can start the notebook server from the command line by running the following command + +``` +marvin notebook +``` + +Use notebooks to demonstrate how to use the lib features. It can also be useful to show some use cases. + + +### Bumping version + +``` +marvin pkg-bumpversion [patch|minor|major] +git add . && git commit -m "Bump version" +``` + + +### Tagging version + +``` +marvin pkg-createtag +git push origin master --follow-tags +``` + + +### Logging + +The default log level is set to _WARNING_. You can change the log level at runtime setting another value to one of the following environment variable: `MARVIN_IRIS_SPECIES_ENGINE_LOG_LEVEL` or `LOG_LEVEL`. The available values are _CRITICAL_, _ERROR_, _WARNING_, _INFO_ and _DEBUG_. + +Be careful using `LOG_LEVEL`, it may affect another lib. \ No newline at end of file diff --git a/site/marvin-platform-book/ch3_get_started/mnist_engine.md b/site/marvin-platform-book/ch3_get_started/mnist_engine.md new file mode 100644 index 0000000..2c82dbc --- /dev/null +++ b/site/marvin-platform-book/ch3_get_started/mnist_engine.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# MNIST Engine + +Text here \ No newline at end of file diff --git a/site/marvin-platform-book/ch3_get_started/overview.md b/site/marvin-platform-book/ch3_get_started/overview.md new file mode 100644 index 0000000..d76a11e --- /dev/null +++ b/site/marvin-platform-book/ch3_get_started/overview.md @@ -0,0 +1,29 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# General Overview +In this chapter we have some exemples of how to create and work with an engine. \ No newline at end of file diff --git a/site/marvin-platform-book/ch3_get_started/sms_engine.md b/site/marvin-platform-book/ch3_get_started/sms_engine.md new file mode 100644 index 0000000..5705a22 --- /dev/null +++ b/site/marvin-platform-book/ch3_get_started/sms_engine.md @@ -0,0 +1,195 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# SMS Engine + +## Overview + +SMS Spam engine + + +## Requirements + + - Python 2.7.9 or higher + - Pandas 0.20.3 or higher + - Sklearn 0.18.2 or higher + +## Development + +### Getting started + +First, create a new virtualenv for this engine in your python toolbox env + +``` +marvin engine-generateenv /your/path/to/sms_spam_engine_env +``` + +Now move to the new env and run tests to confirm everything is fine + +``` +workon sms-spam-engine-env +marvin test +``` + +You are now ready to code. + + +### API docs + +Active your engine env + +``` +workon sms-spam-engine-env +``` + +Start http server + +``` +marvin engine-httpserver +``` + +Open the API doc page in your browser + +``` +localhost:8000/docs/ +``` + +You can send request directly from docs page to you engine server using "Try it out" and "Execute" buttons + + +### Adding new dependencies + +It\`s very important. All development dependencies should be added to `setup.py`. + +### Running tests + +This project uses *[py.test](http://pytest.org/)* as test runner and *[Tox](https://tox.readthedocs.io)* to manage virtualenvs. + +To run all tests use the following command + +``` +marvin test +``` + +To run specific test + +``` +marvin test tests/test_file.py::TestClass::test_method +``` + + +### Writting documentation + +The project documentation is written using *[Jupyter](http://jupyter.readthedocs.io/)* notebooks. +You can start the notebook server from the command line by running the following command + +``` +marvin notebook +``` + +Use notebooks to demonstrate how to use the lib features. It can also be useful to show some use cases. + + +### Bumping version + +``` +marvin pkg-bumpversion [patch|minor|major] +git add . && git commit -m "Bump version" +``` + + +### Tagging version + +``` +marvin pkg-createtag +git push origin master --follow-tags +``` + + +### Logging + +The default log level is set to _WARNING_. You can change the log level at runtime setting another value to one of the following environment variable: `MARVIN_SMS_SPAM_ENGINE_LOG_LEVEL` or `LOG_LEVEL`. The available values are _CRITICAL_, _ERROR_, _WARNING_, _INFO_ and _DEBUG_. + +Be careful using `LOG_LEVEL`, it may affect another lib. + + +## Installation + +Use the Marvin toolbox to provision, deploy and start the remote HTTP server. + +First, edit the `marvin.ini` file, setting the options within the +`ssh_deployment` section: + +1. `host`: the host IP address or name where the engine should be deployed. You +can enable multi-host deployment using `,` to separate hosts +2. `port`: the SSH connection port +3. `user`: the SSH connection username. Currently, only a single user is +supported. This user should be capable of *passwordless sudo*, although it can +use password for the SSH connection + +Next, ensure that the remotes servers are provisioned (all required software +are installed): + + marvin engine-deploy --provision + +Next, package your engine: + + marvin engine-deploy --package + +This will create a compressed archive containing your engine code under the +`.packages` directory. + +Next, deploy your engine to remotes servers: + + marvin engine-deploy + +By default, a dependency clean will be executed at each deploy. You can skip it +using: + + marvin engine-deploy --skip-clean + +Next, you can start the HTTP server in the remotes servers: + + marvin engine-httpserver-remote start + +You can check if the HTTP server is running: + + marvin engine-httpserver-remote status + +And stop it: + + marvin engine-httpserver-remote stop + +After starting, you can test it by making a HTTP request to any endpoint, like: + + curl -v http://example.com/predictor/health + +Under the hood, this engine uses Fabric to define provisioning and deployment +process. Check the `fabfile.py` for more information. You can add new tasks or +edit existing ones to match your provisioning and deployment pipeline. + + diff --git a/site/marvin-platform-book/ch4_documentation/engine_cli.md b/site/marvin-platform-book/ch4_documentation/engine_cli.md new file mode 100644 index 0000000..a8c35e0 --- /dev/null +++ b/site/marvin-platform-book/ch4_documentation/engine_cli.md @@ -0,0 +1,60 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Engine CLI + +### Command line interface +Usage: marvin [OPTIONS] COMMAND [ARGS] + +Options: +``` + --debug #Enable debug mode. + --version #Show the version and exit. + --help #Show this command line interface and exit. +``` + +Commands: +``` + engine-generate #Generate a new marvin engine project. + engine-generateenv #Generate a new marvin engine environment. + engine-grpcserver #Marvin gRPC engine action server starts. + engine-httpserver #Marvin http api server starts. + hive-dataimport #Import data samples from a hive databse to the hive running in this toolbox. + hive-generateconf #Generate default configuration file. + hive-resetremote #Drop all remote tables from informed engine on host. + notebook #Start the Jupyter notebook server. + pkg-bumpversion #Bump the package version. + pkg-createtag #Create git tag using the package version. + pkg-showchanges #Show the package changelog. + pkg-showinfo #Show information about the package. + pkg-showversion #Show the package version. + pkg-updatedeps #Update requirements.txt. + test #Run tests. + test-checkpep8 #Check python code style. + test-tdd #Watch for changes to run tests automatically. + test-tox #Run tests using a new virtualenv. +``` \ No newline at end of file diff --git a/site/marvin-platform-book/ch4_documentation/generic_rest_api.md b/site/marvin-platform-book/ch4_documentation/generic_rest_api.md new file mode 100644 index 0000000..74f86ec --- /dev/null +++ b/site/marvin-platform-book/ch4_documentation/generic_rest_api.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Generic Rest API + +Text goes here \ No newline at end of file diff --git a/site/marvin-platform-book/ch4_documentation/setting_params.md b/site/marvin-platform-book/ch4_documentation/setting_params.md new file mode 100644 index 0000000..2a200b1 --- /dev/null +++ b/site/marvin-platform-book/ch4_documentation/setting_params.md @@ -0,0 +1,55 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Setting Environmental Variables + +To set up environmental parameters or variables on Marvin it's recommended +to use the argument ```params``` that is present on every engine actions. + +## Setting up params +You may edit the file *engine.params* that is located at the root directory +of your engine. You must insert params as a dictionary: + +``` +{ + "login" : "marvin", + "password": "123455" +} +``` + +## Loading params +Params are loaded as an argument on your engine execution. Then, inside your +code you must do ```params.get("login")``` or ```params["login"]``` to access +those variables. + +## Samples +* [Example of *engine.params* file](https://github.com/marvin-ai/marvin-public-engines/blob/master/iris-species-engine/engine.params) +* [Example of loading params on **Acquisitor and Cleaner**](https://github.com/marvin-ai/marvin-public-engines/blob/master/iris-species-engine/marvin_iris_species_engine/data_handler/acquisitor_and_cleaner.py) + +**Notice that if you are running your actions using an API, you may alse set params at +the the API body. These params will overwrite the <i>engine.params</i> file.** + diff --git a/site/marvin-platform-book/ch4_documentation/toolbox_cli.md b/site/marvin-platform-book/ch4_documentation/toolbox_cli.md new file mode 100644 index 0000000..532f94b --- /dev/null +++ b/site/marvin-platform-book/ch4_documentation/toolbox_cli.md @@ -0,0 +1,60 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Toolbox CLI + +### Command line interface +Usage: marvin [OPTIONS] COMMAND [ARGS] + +Options: +``` + --debug #Enable debug mode. + --version #Show the version and exit. + --help #Show this command line interface and exit. +``` + +Commands: +``` + engine-generate #Generate a new marvin engine project. + engine-generateenv #Generate a new marvin engine environment. + engine-grpcserver #Marvin gRPC engine action server starts. + engine-httpserver #Marvin http api server starts. + hive-dataimport #Import data samples from a hive databse to the hive running in this toolbox. + hive-generateconf #Generate default configuration file. + hive-resetremote #Drop all remote tables from informed engine on host. + notebook #Start the Jupyter notebook server. + pkg-bumpversion #Bump the package version. + pkg-createtag #Create git tag using the package version. + pkg-showchanges #Show the package changelog. + pkg-showinfo #Show information about the package. + pkg-showversion #Show the package version. + pkg-updatedeps #Update requirements.txt. + test #Run tests. + test-checkpep8 #Check python code style. + test-tdd #Watch for changes to run tests automatically. + test-tox #Run tests using a new virtualenv. +``` \ No newline at end of file diff --git a/site/marvin-platform-book/ch4_documentation/toolbox_common_lib.md b/site/marvin-platform-book/ch4_documentation/toolbox_common_lib.md new file mode 100644 index 0000000..3c0d340 --- /dev/null +++ b/site/marvin-platform-book/ch4_documentation/toolbox_common_lib.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Toolbox Common Lib + +Text goes here \ No newline at end of file diff --git a/site/marvin-platform-book/ch5_deploying/deploying.md b/site/marvin-platform-book/ch5_deploying/deploying.md new file mode 100644 index 0000000..4a13a3f --- /dev/null +++ b/site/marvin-platform-book/ch5_deploying/deploying.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Deploying Into Produciton + +Text goes here \ No newline at end of file diff --git a/site/marvin-platform-book/ch5_deploying/overview.md b/site/marvin-platform-book/ch5_deploying/overview.md new file mode 100644 index 0000000..34fe53c --- /dev/null +++ b/site/marvin-platform-book/ch5_deploying/overview.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# General Overview + +Here we will explain the design pattern for MARVIN AI \ No newline at end of file diff --git a/site/marvin-platform-book/ch6_platform_architecture/overview.md b/site/marvin-platform-book/ch6_platform_architecture/overview.md new file mode 100644 index 0000000..34fe53c --- /dev/null +++ b/site/marvin-platform-book/ch6_platform_architecture/overview.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# General Overview + +Here we will explain the design pattern for MARVIN AI \ No newline at end of file diff --git a/site/marvin-platform-book/ch7_community/community.md b/site/marvin-platform-book/ch7_community/community.md new file mode 100644 index 0000000..5bdc783 --- /dev/null +++ b/site/marvin-platform-book/ch7_community/community.md @@ -0,0 +1,34 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Community + +# Github + +# Roadmap + +# How To Contribute \ No newline at end of file diff --git a/site/marvin-platform-book/ch7_community/overview.md b/site/marvin-platform-book/ch7_community/overview.md new file mode 100644 index 0000000..34fe53c --- /dev/null +++ b/site/marvin-platform-book/ch7_community/overview.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# General Overview + +Here we will explain the design pattern for MARVIN AI \ No newline at end of file diff --git a/site/marvin-platform-book/ch8_versions/overview.md b/site/marvin-platform-book/ch8_versions/overview.md new file mode 100644 index 0000000..34fe53c --- /dev/null +++ b/site/marvin-platform-book/ch8_versions/overview.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Community Members +description: Project Community Page +group: nav-right +--- +<!-- +{% comment %} +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# General Overview + +Here we will explain the design pattern for MARVIN AI \ No newline at end of file ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
