This blog is intended to help new users learn and become comfortable with the H2O Wave framework. Use the Overview section for an ordered-list of how to get started, learn more, and get hands on with the capabilities of H2O Wave. Move onto the Examples and Existing Apps to see what’s possible and being built by other developers. In the Friends of Wave section you can learn about companion libraries which help take your Wave projects to the next level.
The best way to get started with a product is to read it’s docs and do some examples. It’s not always fun or glamorous, but each link below will take 1 to 10 minutes to read/execute and is the best way to get you up to speed on what is possible, where Wave excels, and to have everything running on your local machine.
Have feedback? Documentation is often written by the product experts. Have an opinion on something that is confusing, could be more clear, or is missing? Add a note in the Wave Discussions or feel free to make the changes and open a pull request (PR).
- Learn what Wave does
- Install the software on your local workstation
- Run a pre-built app on your local workstation to have access to over 150 examples
- Work through the Hello World, Beer Wall, System Monitor, Bean Counter, and Todo List tutorials
The best way to learn details on the intricacies of a product is to read it’s docs. It’s not always fun or glamorous, but each guide topic will take 3 to 15 minutes to read and make you the expert at various topics in the Wave framework.
Start at the introduction and then use the left hand navigation to read through all topics or pick the ones you are most interested in.
- Wave Scripts
- Wave Apps
- Data Buffers
- Query Arguments
- App State
- Realtime Sync
- Background Tasks
- Command Line Interface
- Browser Testing
- Backup and Recovery
Once you are feeling like you get how Wave works and what it is good for, it’s time to find the code. Start by reading the GitHub README which explains more about the project from a technical perspective.
Browse the recent Discussions to get an idea of what types of questions people have. A great way to learn is to teach! Look for an unanswered question, if it’s a bug and there’s no reproducible example, make one! If it’s asking how to do some specific task see if you can make an example.
Checkout specifically the Show and Tell section of the Discussions to get some inspiration for using Wave and best practices. Don’t forget to contribute to the community and make your own Show and Tell post when you develop something you’re proud of.
Another great way to learn about a product is to check out the Issues. Read through the suggested features from the community and the new features documented by the Development team to see where the product is going. Again, see a bug ticket with no reproducible example? Make one!
Finally, get details on the entire API from the documentation page to learn what functions are available and the parameters and outputs of each one.
Another good way of knowing what the product can do is to look at what features are new. Checkout the Change Log for a simple, ordered list. You can also check out the Blog for more news and details on Wave and releases.
See a point in the Change Log or Blog that you want to know more about? Head over to the source code and search for your key word in the Issues, PRs, and generally in GitHub. Then browse the conversations, code, and docs to learn more.
A great way to learn what is possible with H2O Wave is to look at existing apps! Find an app you like? Go to the source code in GitHub, clone the repo, and try running the app on your local workstation. Make some changes to the app and see what happens. Read through the code to learn how it works. Maybe even fix a bug or add a new feature and submit a pull request (PR).
Here is a list of some apps you may want to use as reference:
- A Tour of Wave - these are 150+ short examples which can be accessed in several different ways
- Use the documentation at wave.h2o.ai when you want to search for something and get an example app returned. Look for the Examples title in the search results.
- Explore the examples directly in the documentation gallery
- Run the examples as single app, a Tour of Wave, on your local workstation
- Sample Applications - these eight apps can be used as a starting point in your app development journey. Have an idea for how to improve them or streamline the source code or make the code more readable? Make some changes and a PR.
- Explainable Hotel Ratings: This app allows you to filter hotel reviews and compare the most common phrases from the subset to the overall most common phrases.
- Guess the Number: This a game where the machine "thinks" of a number and the human has to guess, getting told higher or lower. This application has a leader board where different users can compete to see who can guess numbers in the fewest number of turns, on average. This application teaches the developer about different app states and could be fun for new users.
- Human-in-the-Loop Credit Risk: This application allows a business user to review model predictions on whether or not someone will pay off their credit card - a model used to approve or deny credit card applications. Specifically, this app provides a list of predictions the model is not confident about (predictions in the 0.4 to 0.6 range) and allows the end user to mark someone as approved or not.
- Mitigating Churn Risk: This application builds a churn prediction model with H2O-3 and provides the likelihood to churn and actionable recommendations to prevent churn via nicely-presented top shapley values.
- Online Shopping Recommendations: This application allows a marketing analyst to understand how their recommendation engine works. It allows them to add items to their cart and as they do a list of recommended products is updated.
- Sales Forecasting EDA: This application provides an easy-to-use interface for exploring historical sales values and looking at future forecasts across store segments.
- Social Media Sentiment: This application pulls tweets and uses the open source VaderSentiment to understand positive and negative tweets.
- Big Data Visualizer - This application was started live in a webinar which gives you an idea of both how to build your own apps and also what is possible in an hour once you’re comfortable with the product. You can learn more about the inspiration for this app in this blog post.
WaveML is a companion package to H2O Wave which makes it quick and easy to integrate machine learning models into Wave applications. This is done with a simple, high-level API to train, deploy, score, and explain ML models. This package uses H2O’s open source AutoML and can optionally use Driverless AI.
Get started by first reading the ReadMe in Github which includes an installation guide to and quickstart example to get started.
Information we have already looked at is pertinent for WaveML, too:
- There is a guide section on WaveML
- Twelve of the Tour of Wave examples are on WaveML
- The Mitigating Churn Risk and Human-in-the-Loop Credit Risk OSS example apps use Wave-ML
- WaveML API can be found in the Wave API documentation
WaveDB is a lightweight companion database to Wave, based on SQLite. WaveDB is SQLite with a HTTP interface. It is a ~6MB (~2MB UPX-compressed) self-contained, zero-dependency executable that bundles SQLite 3.35.5 (2021-04-19) with JSON1, RTREE, FTS5, GEOPOLY, STAT4, and SOUNDEX.
If you are already a fan of SQLite, WaveDB acts as a thin HTTP-server wrapper that lets you access your SQLite databases over a network. WaveDB can be used as a lightweight, cross-platform, installation-free companion SQL database for Wave apps. The h2o-wave package includes non-blocking async functions to access WaveDB.
Information we have already looked at is pertinent for WaveDB, too:
- There is a Guide section on WaveDB which included how to download and install the database
- Two of the Tour of Wave examples are on WaveDB
- WaveDB API can be found in the Wave API documentation
We hope that this helps with getting started and learning more about H2O Wave. Use the GitHub discussion board or tag us on Twitter with any questions or reference to what you’re building!