Managing a Project

Guide to Creating and Managing ML and KPI Projects

After successful login, the home page is displayed, which contains all the Projects that are currently owned by you. This page also contains the list of Projects that are delegated to you. A User can also add Project, check script failure logs and launch Jupyter Notebook related to each project.

Custom Project

For building a custom ML project from scratch, a User must first design the project solution to keep the code modular. Project consists of Stages ( for structuring the Project by subdividing a computer program into individual sub-programs.) Basic three stages could be Input Data, Learning and Output data. User may also subdivide these stages depending on the team members and which member is to be given access as Collaborator, Stage Writer or Observer.

Clicking on Add Project link will give a Pop up form for creating a new custom project. A User can provide a Project Title, Process_Id, Process Description and Emails of Collaborators and click on Add New Project Button to create a new Project.

On submission a pop up window will open where a User can add first Stage by providing the Title of the stage.

A user can add Stages to the new project by selecting the new project Title in Select Project menu. Please refer to documentation on Select and Manage Project for further help.

Performance & Threat Manager

These Projects are used to define and measure KPI (Key Performance Indicators). A User can quantify risks to future goals and also assess actions to mitigate these risks.

Clicking on Add Project link will give a Pop up form for creating a new custom project. A User can provide a Project Title, Process_Id, Process Description and Emails of Collaborators and click on Add New Project Button to create a new Project.

On submission a pop up window will open where a User can add first Stage by providing the Title of the stage.

A user can add Stages to the new project by selecting the new project Title in Select Project menu. Please refer to documentation on Select and Manage Project (mainly sections related to Dashboard, Process Flow and Settings) for further help.

Select and Manage Project/s

User can select a Project from the drop down menu Select Project at the top center of the Home page. This will lists all the Projects (Title) where user is the owner and also Projects where access to work is given by other users/developers.

A User can also select a Template at the top center of the Home page.

Clicking on Projects will give a Grid view of all the projects containing Title and number of Collaborators, Stages and Variables along with a link Go to manage the project. Clicking on Show Projects link will also give this same Grid view of all the projects.

Project Flow Tab

On the Project Page (Process Flow Tab) a user can manage Stages in the project. A Project consists of Stages ( for structuring the Project by subdividing a computer program into individual sub-programs.) Each stage have functionality for creating Properties, entering/uploading Data and writing Python scripts. A user can also post the property fields on Web Portal (web.wynum.com) using APIs.

On Process Flow Tab user also have a list of all the Scripts and APIs used in the project. A search box is also provided for searching a particular Script or API. Clicking on a Script a user can Click on I/O , Edit , Delete, Info and Test to Edit the script, Edit name and Properties, Delete, get information and test the script. Similarly a User can Update or Delete a API upon clicking on a selected API in the list.

Process Flow Tab also have a top right menu for adding stages ( ) to the Project, adding Global Variables, check Log, Share project with other users (as Collaborator or Observer or Stage Writer) and for creating Groups of stages.

​ Icon

A New stage can be added by providing a Title of the new stage or an existing Public/Private stage can also be selected from the list in the form. Clicking on the Add Stage submit button will create a new stage.

Global Variables

Here a User can add or edit or delete Unique Identifier, Unique Identifier Objects and Global Variable used in the project. For adding a new Variable a User can provide a Name and Value of the Global Variable.

Unique Identifier

Clicking on the Unique identifier Tab a user can change the identifier. The default Unique Identifier is id of the particular project.

Unique Identifier Objects

Clicking on Unique Identifier Objects Tab will list all the available identifier Objects. A User can search (by typing the key in the search box) and delete the Objects.

Global Variable

Clicking on Global Variable Tab will list all the existing Variables along with Value and Actions (to remove the variable). For adding a new Variable a User can provide a Name and Value of the Global Variable. A Global variable can also be an Array Type.

Log

Clicking on Log will give a Pop up window showing all the logs related the project. A User can Filter by date, Search by Keywords, Load More logs or Close the window.

Share

A User can share a Project with other Users by adding the Email address and the Role of the User. A user can be added as Project Collaborator, Observer or Stage Writer.

Project Collaborator has same permission as the owner of the project and a User with access as Collaborator can add and delete stages, make changes in the scripts and APIs and can add other users for collaboration.

Observer gets to manage Charts and Data forms of the project. A User with access as Observer can make new Charts in the Dashboard Tab or Upload data in the Document Tab.

Stage Writer have access to data forms of a particular assigned Stage/s.

A user can share the Data form (exposed through the Post API) by providing the User Email. Clicking on the Share Project Button will open a Pop up window containing links for adding Collaborators and Users. A User can share the data form by clicking on Users Link and submitting the Select Stage, Title, Form Title, Component URL and POST URL to generate the required Tokens.

A User can then add Process User by entering the Email Address of the select Users.

Groups

A User can add Stages to a named Group of Stages by providing Title of the Group, Description and selecting all the required stages. A User can also edit and delete the existing Group of Stages.

Dashboard (Demo Portal)

When a User creates any Properties (Variables) of Numbers, Choice or Multiple Choice Types a User gets to add Single Variable Charts (Pie Chart, Line Chart or Histogram) or Multiple Variable Charts (BoxPlot) on the User Dashboard.

A User can write description or filter on max and min of the variables or download or chat with other users (Collaborators/Observers) or remove each presented Chart.

Dashboard also have utilities for tacking correlation, Variables KPIs.

Track Correlations

A user can select Variables/Properties and find the coefficient of correlation between them.

  • A correlation coefficient of 1 means that for every positive increase in one variable, there is a positive increase of a fixed proportion in the other. For example, shoe sizes go up in (almost) perfect correlation with foot length.

  • A correlation coefficient of -1 means that for every positive increase in one variable, there is a negative decrease of a fixed proportion in the other. For example, the amount of gas in a tank decreases in (almost) perfect correlation with speed.

  • Zero means that for every increase, there isn’t a positive or negative increase. The two just aren’t related.

The absolute value of the correlation coefficient gives us the relationship strength. The larger the number, the stronger the relationship. For example, |-.75| = .75, which has a stronger relationship than .65.

Track Variables

A User can select a Stage and Variables and select a plot to add to the Dashboard.

Track KPI

A Key Performance Indicator is a measurable value that demonstrates how effectively a company is achieving key business objectives. Organizations use KPIs at multiple levels to evaluate their success at reaching targets. High-level KPIs may focus on the overall performance of the business, while low-level KPIs may focus on processes in departments such as sales, marketing, HR, support and others.

A User can define a KPI (Key Performance Indicator) by giving a Title and selecting a Chart and then plotting the data from a Stage and then performing an Operation like Min/max/etc and writing a formula for the KPI. This chart is added to the dashboard.

Documents

Document contains all the data forms in a project for which a User have been given access as a Observer. A User can submit the form by clicking on Submit button after completing the form.

Settings

A User can change the name of the project, delete a project and manage the versions/releases of a project from the Settings Link. Setting Tab can be seen only for the project where a User is the Owner of the project.

Change Name

After providing Project Name, Description and Image URL a User can clink on the Update button to change the name of the project.

Delete Project

A User can delete a selected project by Retyping Project Name and clicking on the Delete button.

Project Versions

A User can name the Versions of project and Release a selected version from time to time.

Jupyter Notebook

A User can Launch , Restart or Push Data on Jupyter Notebook Tab. First time usage of Jupyter Notebook (for projects where User is a Owner) will require a Token which a User can find in the registered email. For Opening a Jupyter Notebook (for projects where a User is a Collaborator) a Token is provided by the Owner of the project.

Launch

The Jupyter Notebook is an open-source web application that allows you to create and share documents that contain live code, equations, visualizations and narrative text. Uses include: data cleaning and transformation, numerical simulation, statistical modeling, data visualization, machine learning

Restart

Restarting a Jupyter Notebook will remove all the packages a User have manually installed. A User can choose new Password and restart the Jupyter notebook by clicking on the Restart button.

Push Data

Clicking on Push data will push the data in CSV format (from all the stages in the project) to Jupyter Notebook and on Launching the Notebook a user will be able open the updated data file in excel sheet.