When creating an App in the Virtualitics AI Platform (VAIP), it is important to familiarize with the key components that make up an App. Each of these components can be thought of as building blocks that layer to make up the full App experience for a user. For more on structuring your code for these building blocks, see this article.
Building an App
Apps built using the Virtualitics SDK are written in Python, leveraging a language familiar to Data Scientists. Developers can also import their own custom packages when developing an App. For more on importing custom packages, see this article.
At the highest level, Users open an App from the VAIP Home Page, and run through the analytic workflow of the App by navigating through multiple Steps. Each Step is displayed to a user using a Page, populated with one or more Page Elements. An instance of a user navigating through an App is considered a Flow.
Components of an App
When developing an App, you’ll likely leverage most, if not all, of these components:
- Steps: Apps are comprised of Steps, which can be thought of as a component of a Flow.
- Pages: Objects that govern the appearance of the frontend in the VAIP. This is what is displayed to a user of an App.
- Elements: Objects that allow users to upload, view, and interact with data within the App. A collection of Page Elements organized logically using Sections and/or Cards make up a Page.
-
Persistence: The ability to save data in a system so that the data's value can later be retrieved.
- Assets: A form of data persistence that enables information to flow across different Apps and Flows.
- Outputs: A form of data persistence that enables information to flow between Steps within a single Flow in an App.
- Deploying an App: Once you have written your App, you can upload that App to the VAIP. By uploading a Python file, you are able to productize and deploy your own App for data analysis and prediction.
With familiarity of the essential building blocks of an App, the first thing to do is to install the SDK and CLI Packages to begin development. For more on how to do so, see this article.
App Creation Tutorials
In addition to more detailed documentation, the following guided tutorials are available for you to practice developing for the VAIP:
Additional Technical Documentation
For in-depth technical documentation, visit the Virtualitics SDK.