Getting Started

To learn about Platform for Situated Intelligence, we recommend you begin with the Brief Introduction, which provides a guided walk-through for some of the main concepts in \psi. It shows how to create a simple program, describes the core concept of a stream, and explains how to transform, synchronize, visualize, persist and replay streams from disk. We recommend that you first work through the examples in this tutorial to familiarize yourself with these core concepts.

If you prefer getting started by watching a presentation about the framework, this online video gives a 30 minute high-level overview of the framework, followed by a 30 minute hands-on coding session illustrating how to write a first, simple application.

In addition, a number of tutorials, samples, and other resources can help you learn more about the framework, as described below:

Tutorials. Several tutorials are available to help you get started with using Platform for Situated Intelligence. We recommend beginning with the Writing Components tutorial, which explains how to write new \psi components, and the Pipeline-Execution and Delivery Policies tutorials, which describe how to control the execution of pipelines and how to control throughput on streams in your application. A number of additional tutorials provide information about the set of basic stream operators available in the framework, as well as stream operators for fusion and merging, interpolation and sampling, windowing, and stream generation.

Other Topics. Several documents provide information about various specialized scenarios such as running distributed Platform for Situated Intelligence applications via remoting, bridging to Python, JS, etc., shared objects and memory management, etc.

Samples. Besides the tutorials and topics, it may be helpful to look through the set of Samples provided. While some of the samples address specialized topics such as how to leverage speech recognition components, how to bridge to ROS, or how to write HoloLens applications using \psi, reading them will give you more insight into programming with \psi.

Components. Additional useful information regarding available packages and components can be found in the NuGet packages list and in the component list pages. The latter page also has pointers to other repositories by third parties containing other \psi components.

Documentation. Like the rest of the codebase, the documentation available in this wiki is still under construction and in various phases of completion. If you need further explanation in any of these areas, please open an issue, label it documentation, as this will help us target our documentation development efforts to the highest priority needs.