postgresml · montanalow · Apr 18, 2022 · Apr 17, 2022 · Apr 17, 2022 · Apr 17, 2022
diff --git a/MIT-LICENSE.txt b/MIT-LICENSE.txt
@@ -0,0 +1,20 @@
+Copyright (c) 2022 Lev Kokotov and Montana Low
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,6 +1,144 @@
 # PostgresML
 
-PostgresML aims to be the easiest way to gain value from machine learning. Anyone with a basic understanding of SQL should be able to build and deploy models to production, while receiving the benefits of a high performance machine learning platform. PostgresML leverages state of the art algorithms with built in best practices, without having to setup additional infrastructure or learn additional programming languages.
+![PostgresML](./logo-small.png)
+
+PostgresML is an end-to-end machine learning system. Using only SQL, it allows to train models and run online predictions, alongside normal queries, directly using the data in your databases.
+
+## Why
+
+Deploying machine learning models into existing applications is not straight forward. Unless you're already using Python in your day to day work, you need to learn a new language and toolchain, figure out how to EL(T) your data from your database(s) into a warehouse or object storage, learn how to train models (Scikit-Learn, Pytorch, Tensorflow, etc.), and finally serve preditions to your apps, forcing your organization into microservices and all the complexity that comes with it.
+
+PostgresML makes ML simple: your data doesn't really go anywhere, you train using simple SQL commands, and you get the predictions to your apps using a mechanism you've been using already: a Postgres connection and a query.
+
+Our goal is that anyone with a basic understanding of SQL should be able to build and deploy machine learning models to production, while receiving the benefits of a high performance machine learning platform. Ultimately, PostgresML aims to be the easiest, safest and fastest way to gain value from machine learning.
+
+## Quick start
+
+Using Docker, boot up PostresML locally:
+
+```bash
+$ docker-compose up
+```
+
+The system is available on port 5433 by default, just in case you happen to be running Postgres already:
+
+```bash
+$ psql -U root -h 127.0.0.1 -p 5433
+```
+
+We've included a couple examples in the `examples/` folder. You can run them directly with: 
+
+```bash
+$ psql -U root -h 127.0.0.1 -p 5433 -f <filename>
+```
+
+See [installation instructions](#Installation) for installing PostgresML in different supported environments, and for more information.
+
+## Features
+
+### Training models
+
+Given a Postgres table or a view, PostgresML can train a model using some commonly used algorithms. We currently support the following Scikit-Learn regression and classification models:
+
+- `LinearRegression`,
+- `LogisticRegression`,
+- `SVR`,
+- `SVC`,
+- `RandomForestRegressor`,
+- `RandomForestClassifier`,
+- `GradientBoostingRegressor`,
+- `GradientBoostingClassifier`.
+
+Training a model is then as simple as:
+
+```sql
+SELECT * FROM pgml.train(
+     'Human-friendly project name',
+     'regression', 
+     '<name of the table or view containing the data>',
+     '<name of the column containing the y target values>'
+);
+```
+
+PostgresML will snapshot the data from the table, train multiple models from the above list given the objective (`regression` or `classification`), and automatically choose and deploy the model with the best predictions.
+
+### Making predictions
+
+Once the model is trained, making predictions is as simple as:
+
+```sql
+SELECT pgml.predict('Human-friendly project name', ARRAY[...]) AS prediction_score;
+```
+
+where `ARRAY[...]` is a list of features for which we want to run a prediction. This list has to be in the same order as the columns in the data table. This score then can be used in normal queries, for example:
+
+```sql
+SELECT *,
+       pgml.predict(
+          'Probability of buying our products',
+          ARRAY[user.location, NOW() - user.created_at, user.total_purchases_in_dollars]
+       ) AS likely_to_buy_score
+FROM users
+WHERE comapany_id = 5
+ORDER BY likely_to_buy_score
+LIMIT 25;
+```
+
+Take a look [below](#Working-with-PostgresML) for an example with real data.
+
+### Model and data versioning
+
+As data in your database changes, it is possible to retrain the model again to get better predictions. With PostgresML, it's as simple as running the `pgml.train` command again. If the model scores better, it will be automatically used in predictions; if not, the existing model will be kept and continue to score in your queries. We also snapshot the training data, so models can be retrained deterministically to validate and fix any issues.
+
+## Roadmap
+
+This project is currently a proof of concept. Some important features, which we are currently thinking about or working on, are listed below.
+
+### Production deployment
+
+Most companies that use PostgreSQL in production do so using managed services like AWS RDS, Digital Ocean, Azure, etc. Those services do not allow running custom extensions, so we have to run PostgresML
+directly on VMs, e.g. EC2, droplets, etc. The idea here is to replicate production data directly from Postgres and make it available in real-time to PostgresML. We're considering solutions like logical replication for small to mid-size databases, and Debezium for multi-TB deployments.
+
+### Model management dashboard
+
+A good looking and useful UI goes a long way. A dashboard similar to existing solutions like MLFlow or AWS SageMaker will make the experience of working with PostgresML as pleasant as possible.
+
+
+### Data explorer
+
+A data explorer allows anyone to browse the dataset in production and to find useful tables and features to build effective machine learning models.
+
+
+### More algorithms
+
+Scikit-Learn is a good start, but we're also thinking about including Tensorflow, Pytorch, and many more useful models.
+
+
+### Scheduled training
+
+In applications where data changes often, it's useful to retrain the models automatically on a schedule, e.g. every day, every week, etc.
+
+
+### FAQ
+
+*How far can this scale?*
+
+Petabyte sized Postgres deployements are [documented](https://www.computerworld.com/article/2535825/size-matters--yahoo-claims-2-petabyte-database-is-world-s-biggest--busiest.html) in production since at least 2008, and [recent patches](https://www.2ndquadrant.com/en/blog/postgresql-maximum-table-size/) have enabled working beyond exabyte and up to the yotabyte scale. Machine learning models can be horizontally scaled using standard Postgres replicas.
+
+*How reliable can this be?*
+
+Postgres is widely considered mission critical, and some of the most [reliable](https://www.postgresql.org/docs/current/wal-reliability.html) technology in any modern stack. PostgresML allows an infrastructure organization to leverage pre-existing best practices to deploy machine learning into production with less risk and effort than other systems. For example, model backup and recovery happens automatically alongside normal Postgres data backup.
+
+*How good are the models?*
+
+Model quality is often a tradeoff between compute resources and incremental quality improvements. Sometimes a few thousands training examples and an off the shelf algorithm can deliver significant business value after a few seconds of training. PostgresML allows stakeholders to choose several different algorithms to get the most bang for the buck, or invest in more computationally intensive techniques as necessary. In addition, PostgresML automatically applies best practices for data cleaning like imputing missing values by default and normalizing data to prevent common problems in production. 
+
+PostgresML doesn't help with reformulating a business problem into a machine learning problem. Like most things in life, the ultimate in quality will be a concerted effort of experts working over time. PostgresML is intended to establish successful patterns for those experts to collaborate around while leveraging the expertise of open source and research communities.
+
+*Is PostgresML fast?*
+
+Colocating the compute with the data inside the database removes one of the most common latency bottlenecks in the ML stack, which is the (de)serialization of data between stores and services across the wire. Modern versions of Postgres also support automatic query parrellization across multiple workers to further minimize latency in large batch workloads. Finally, PostgresML will utilize GPU compute if both the algorithm and hardware support it, although it is currently rare in practice for production databases to have GPUs. We're working on [benchmarks](sql/benchmarks.sql).
+
 
 ## Installation
 
@@ -99,15 +237,16 @@ $ psql -c 'SELECT pgml.version()'
 
 The two most important functions the framework provides are:
 
-1. `pgml.train(project_name TEXT, objective TEXT, relation_name TEXT, y_column_name TEXT)`,
+1. `pgml.train(project_name TEXT, objective TEXT, relation_name TEXT, y_column_name TEXT, algorithm TEXT DEFAULT NULL)`,
 2. `pgml.predict(project_name TEXT, VARIADIC features DOUBLE PRECISION[])`.
 
-The first function trains a model, given a human-friendly project name, a `regression` or `classification` objective, a table or view name which contains the training and testing datasets,
-and the name of the `y` column containing the target values. The second function predicts novel datapoints, given the project name for an exiting model trained with `pgml.train`,
-and a list of features used to train that model.
+The first function trains a model, given a human-friendly project name, a `regression` or `classification` objective, a table or view name which contains the training and testing datasets, and the name of the `y` column containing the target values. The second function predicts novel datapoints, given the project name for an exiting model trained with `pgml.train`, and a list of features used to train that model.
 
-We'll be using the [Red Wine Quality](https://www.kaggle.com/datasets/uciml/red-wine-quality-cortez-et-al-2009) dataset from Kaggle for this example. You can find it in the `data` folder in this repository.
-You can import it into PostgresML running in Docker with this:
+You can also browse complete [code examples in the repository](examples/).
+
+### Walkthrough
+
+We'll be using the [Red Wine Quality](https://www.kaggle.com/datasets/uciml/red-wine-quality-cortez-et-al-2009) dataset from Kaggle for this example. You can find it in the `data` folder in this repository. You can import it into PostgresML running in Docker with this:
 
 ```bash
 $ psql -f data/winequality-red.sql -p 5433 -U root -h 127.0.0.1
@@ -159,43 +298,7 @@ LIMIT 1;
 (1 row)
 ```
 
-Checkout the [documentation](https://TODO) to view the full capabilities, including:
-- [Creating Training Sets](https://TODO)
-    - [Classification](https://TODO)
-    - [Regression](https://TODO)
-- [Supported Algorithms](https://TODO)
-    - [Scikit Learn](https://TODO)
-    - [XGBoost](https://TODO)
-    - [Tensorflow](https://TODO)
-    - [PyTorch](https://TODO)
-
-### Planned features
-- Model management dashboard
-- Data explorer
-- More algorithms and libraries incluiding custom algorithm support
-
-
-### FAQ
-
-*How well does this scale?*
-
-Petabyte sized Postgres deployements are [documented](https://www.computerworld.com/article/2535825/size-matters--yahoo-claims-2-petabyte-database-is-world-s-biggest--busiest.html) in production since at least 2008, and [recent patches](https://www.2ndquadrant.com/en/blog/postgresql-maximum-table-size/) have enabled working beyond exabyte up to the yotabyte scale. Machine learning models can be horizontally scaled using well tested Postgres replication techniques on top of a mature storage and compute platform.
-
-*How reliable is this system?*
-
-Postgres is widely considered mission critical, and some of the most [reliable](https://www.postgresql.org/docs/current/wal-reliability.html) technology in any modern stack. PostgresML allows an infrastructure organization to leverage pre-existing best practices to deploy machine learning into production with less risk and effort than other systems. For example, model backup and recovery happens automatically alongside normal data backup procedures.
-
-*How good are the models?*
-
-Model quality is often a tradeoff between compute resources and incremental quality improvements. PostgresML allows stakeholders to choose algorithms from several libraries that will provide the most bang for the buck. In addition, PostgresML automatically applies best practices for data cleaning like imputing missing values by default and normalizing data to prevent common problems in production. After quickly enabling 0 to 1 value creation, PostgresML enables further expert iteration with custom data preperation and algorithm implementations. Like most things in life, the ultimate in quality will be a concerted effort of experts working over time, but that shouldn't get in the way of a quick start.
-
-*Is PostgresML fast?*
-
-Colocating the compute with the data inside the database removes one of the most common latency bottlenecks in the ML stack, which is the (de)serialization of data between stores and services across the wire. Modern versions of Postgres also support automatic query parrellization across multiple workers to further minimize latency in large batch workloads. Finally, PostgresML will utilize GPU compute if both the algorithm and hardware support it, although it is currently rare in practice for production databases to have GPUs. Checkout our [benchmarks](https://todo).
-
-
-
-### Development
+### Contributing
 
 Follow the installation instructions to create a local working Postgres environment, then install your PgML package from the git repository:
 
@@ -205,7 +308,7 @@ sudo python3 setup.py install
 cd ../
 ```
 
-Run the test:
+Run the tests from the root of the repo:
 
 ```
 psql -f sql/test.sql

diff --git a/logo-small.png b/logo-small.png
diff --git a/logo.png b/logo.png