PostgresML is a Postgres extension written in Rust, so it can be built and installed on any systemthatsupported by PostgreSQL and the Rust compiler. If you're planning on using GPU acceleration for Large Language Models or for XGBoost / LightGBM supervised learning, we would recommend you use an operating system well supported by Nvidia drivers and Cuda. Thankfully, that list is pretty large these days, including popular distributions like Ubuntu, Debian, RHEL, Centos, Fedora and OpenSuse.

PostgresML is a Postgres extension written in Rust, so it can be built and installed on any system supported by PostgreSQL and the Rust compiler. If you're planning on using GPU acceleration for Large Language Models or for XGBoost / LightGBM supervised learning, we would recommend you use an operating system well supported by Nvidia drivers and Cuda. Thankfully, that list is pretty large these days, including popular distributions like Ubuntu, Debian, RHEL, Centos, Fedora and OpenSuse.

PostgresML depends on a few system packages and libraries that should be installed separately in order to successfully compile it from source. The names of the packages vary based on the Linux distribution you're using, but in most cases you should be able to find all of themverbatimin your packagemanger repositories:

PostgresML depends on a few system packages and libraries that should be installed separately. The names of the packages vary based on the Linux distribution you're using, but in most cases you should be able to find all of them in your packagemanager repositories:

This guide assumes that you're using PostgreSQL 14, so if your Postgres version is different, replace`14` in`postgresql-server-dev-14` with the correct version of Postgres. PostgresML supports all Postgres versions supported by`pgrx` and the PostgreSQL community (as of this writing, versions 12 through 16).

This guide assumes that you're using PostgreSQL 14, so if your Postgres version is different, replace`14` in`postgresql-server-dev-14` with the correct version. PostgresML supports all Postgres versions supported by`pgrx` and the PostgreSQL community (as of this writing, versions 12 through 16).

All of our source code is open source and hostedin GitHub. You can download it with git:

All of our source code is open source and hostedon GitHub. You can download it with git:

git clone https://github.com/postgresml/postgresml&& \

For a typical deployment in production, you would need to compile and install the extension into your system PostgreSQL installation. PostgresML is using the`pgrx` Rust extension toolkit, so this ispretty easy andstraight forward to do.

For a typical deployment in production, you would need to compile and install the extension into your system PostgreSQL installation. PostgresML is using the`pgrx` Rust extension toolkit, so this is straight forward.

`pgrx` is open source and available from crates.io. We are currently using the`0.10.0` version. It's important that your`pgrx` version matches what we're using, since there are some hard dependencies between our code andtheirs.

`pgrx` is open source and available from crates.io. We are currently using the`0.10.0` version. It's important that your`pgrx` version matches what we're using, since there are some hard dependencies between our code and`pgrx`.

To install`pgrx`, simply run:

This will produce a number of artifacts in`target/release/pg14-pgml` which you can then copy to their respective folders in`/usr` using`sudo cp`. At the timeof thiswriting,`pgrx`is working on a command that does this automatically, but ithas not been released yet.

This will produce a number of artifacts in`target/release/pg14-pgml` which you can then copy to their respective folders in`/usr` using`sudo cp`. At the time writing,`pgrx`was working on a command that does this automatically, but itwas not been released yet.

Once the files are copiedto their respective folders in`/usr`, you need to make surethe`pgml` extension is loaded in`shared_preload_libraries`. We use shared memory to control model versioning and other cool things that make PostgresML "just work". In`/etc/postgresql/14/main/postgresql.conf`, change or add the following line:

Once the files are copiedinto their respective folders in`/usr`, you need to make surethat the`pgml` extension is loaded in`shared_preload_libraries`. We use shared memory to control model versioning and other cool things that make PostgresML "just work". In`/etc/postgresql/14/main/postgresql.conf`, change or add the following line:

To make sure PostgresML is installed, you can create the extension in a database of your choice:

To make sure PostgresML is installed correctly, you can create the extension in a database of your choice: