Installation

A PostgresML deployment consists of two different runtimes. The foundational runtime is a Python extension for Postgres (pgml-extension) that facilitates the machine learning lifecycle inside the database.

Additionally, we provide a dashboard (pgml-dashboard) that can connect to your Postgres server and provide additional management functionality. It will also provide visibility into the models you build and data they use.

Install PostgreSQL with PL/Python

PostgresML leverages Python libraries for their machine learning capabilities. You'll need to make sure the PostgreSQL installation has PL/Python built in.

OS X

We recommend you use Postgres.app because it comes with PL/Python. Otherwise, you'll need to install PL/Python manually. Once you have Postgres.app running, you'll need to install the Python framework. Mac OS has multiple distributions of Python, namely one from Brew and one from the Python community (Python.org); Postgres.app and PL/Python depend on the community one. The following versions of Python and Postgres.app are compatible:

All Python.org installers for Mac OS are available here. You can also get more details about this in the Postgres.app documentation.

Linux

Each Ubuntu/Debian distribution comes with its own version of PostgreSQL, the simplest way is to install it from Aptitude:

                content_copy
                link
                edit
            
$ sudo apt-get install -y postgresql-plpython3-12 python3 python3-pip postgresql-12

Windows

EnterpriseDB provides Windows builds of PostgreSQL available for download.

Install the extension

To use our Python package inside PostgreSQL, we need to install it into the global Python package space. Depending on which version of Python you installed in the previous step, use the corresponding pip executable.

Change the --database-url option to point to your PostgreSQL server.

                content_copy
                link
                edit
            
sudo pip3 install pgml-extension
python3 -m pgml_extension --database-url=postgres://user_name:password@localhost:5432/database_name

If everything works, you should be able to run this successfully:

                content_copy
                link
                edit
            
psql -c 'SELECT pgml.version()' postgres://user_name:password@localhost:5432/database_name

Run the dashboard

The PostgresML dashboard is a Django app, that can be run against any PostgreSQL installation. There is an included Dockerfile if you wish to run it as a container, or you may want to setup a Python venv to isolate the dependencies. Basic install can be achieved with:

1. Clone the repo:

                content_copy
                link
                edit
            
git clone https://github.com/postgresml/postgresml && cd postgresml/pgml-dashboard

2. Set your PGML_DATABASE_URL environment variable:

                content_copy
                link
                edit
            
echo PGML_DATABASE_URL=postgres://user_name:password@localhost:5432/database_name > .env

3. Install dependencies:

                content_copy
                link
                edit
            
pip install -r requirements.txt

4. Run the server:

                content_copy
                link
                edit
            
python manage.py runserver