Guide

The guide is designed to get you quickly started using Scanner for your application, and then gradually expose you to more of the advanced concepts in Scanner.

The guide is organized into the following sections:

  • Quickstart: run a simple Scanner program in as few steps as possible.

  • Installation: get Scanner set up on your machine and ready for writing your own applications.

  • Walkthroughs: step-by-step walkthrough of a Scanner application.

  • Computation Graphs: describes computation graphs, which are how applications are represented in Scanner.

  • Operations: describes the properties of ops (operations). Ops are the nodes in computation graphs that process data.

  • Stored Streams: describes stored streams, which represent streams of data that Scanner can read and write to.

  • Performance Profiling: describes how to profile Scanner jobs and tweak parameters to improve performance.

  • Kubernetes Integration: run Scanner in the cloud with Kubernetes.

Support

If you’re having trouble using Scanner, the best way to get help is to join the Scanner Research slack channel. Send an email to wcrichto@cs.stanford.edu with the subject line “Slack Access” to join our Slack channel.

If you’d like to talk with the core team directly, contact Alex Poms (https://www.cs.cmu.edu/~apoms/) or Will Crichton (http://willcrichton.net/).

If you want to request a new feature or file a bug report, please do so using the GitHub page.