liorsav commented on a change in pull request #57: URL: https://github.com/apache/incubator-liminal/pull/57#discussion_r673281133
########## File path: docs/getting-started/iris_classification.md ########## @@ -0,0 +1,274 @@ +<!-- +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. +--> + +# Getting started / ***Iris Classification*** + +This guide will allow you to set up your first Apache Liminal environment and allow you to create +some simple ML pipelines. These will be very similar to the ones you are going to build for real +production scenarios. + +## Prerequisites + +Python 3 (3.6 and up) + +[Docker Desktop](https://www.docker.com/products/docker-desktop) + +*Note: Make sure kubernetes cluster is running in docker desktop (or custom kubernetes installation +on your machine).* + +## Deploying the Example + +In this tutorial, we will go through setting up Liminal for the first time on your local machine. + +### First, let’s build our example project: + +In the dev folder, just clone the example code from liminal: + + +```BASH +git clone https://github.com/apache/incubator-liminal +``` +***Note:*** *You just cloned the entire Liminal Project, you actually only need examples folder.* + +Create a python virtual environment to isolate your runs: + +```BASH +cd incubator-liminal/examples/aws-ml-app-demo +python3 -m venv env +``` + +Activate your virtual environment: + +```BASH +source env/bin/activate +``` + +Now we are ready to install liminal: + +```BASH +pip install apache-liminal +``` +Let's build the images you need for the example: +```BASH +liminal build +``` +##### The build will create docker images based on the liminal.yml file in the `images` section. + + +Create a kubernetes local volume: +```BASH +liminal create +``` + + +The deploy command deploys a liminal server and deploys any liminal.yml files in your working +directory or any of its subdirectories to your liminal home directory. +```BASH +liminal deploy --clean +``` + + +*Note: liminal home directory is located in the path defined in LIMINAL_HOME env variable. +If the LIMINAL_HOME environemnet variable is not defined, home directory defaults to +~/liminal_home directory.* + +Now lets runs liminal: +```BASH +liminal start +``` +The start command spins up the liminal server containers which will run pipelines based on your +deployed liminal.yml files. Review comment: The start command spins up 3 containers which will run the workflows defined in the liminal.yml file. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
