site_name: PostgresML

site_url: https://postgresml.org/

site_description: Train and deploy models to make online predictions using

only SQL, with an open source Postgres extension.

site_author: PostrgesML Team

repo_name: postgresml/postgresml

repo_url: https://github.com/postgresml/postgresml

edit_uri: /postgresml/postgresml/blob/master/pgml-docs/docs/

watch:

- docs

- overrides

- mkdocs.yml

dev_addr: localhost:8001

theme:

name: material

custom_dir: overrides

favicon: /images/owl.ico

logo: /images/owl_white.png

locale: en

font:

text: Roboto

code: Roboto Mono

highlightjs: true

hljs_languages:

- sql

- bash

palette:

- media: "(prefers-color-scheme: light)"

scheme: default

primary: indigo

accent: blue

toggle:

icon: material/toggle-switch

name: Switch to dark mode

- media: "(prefers-color-scheme: dark)"

scheme: slate

primary: blue

accent: blue

toggle:

icon: material/toggle-switch-off-outline

name: Switch to light mode

features:

- navigation.instant

- navigation.tracking

- navigation.tabs

- navigation.top

- content.code.annotate

extra_css:

- stylesheets/extra.css

extra:

social:

- icon: fontawesome/brands/github

link: https://github.com/postgresml/postgresml

- icon: fontawesome/brands/discord

link: https://discord.gg/DmyJP3qJ7U

generator: false

analytics:

provider: umami

copyright: Copyright © 2022 PostgresML Team

plugins:

- glightbox

- search

- include-markdown

- minify:

minify_html: true

minify_js: true

minify_css: true

htmlmin_opts:

remove_comments: true

markdown_extensions:

- abbr

- admonition

- attr_list

- def_list

- footnotes

- meta

- md_in_html

- toc:

permalink: true

- pymdownx.arithmatex:

generic: true

- pymdownx.betterem:

smart_enable: all

- pymdownx.caret

- pymdownx.details

- pymdownx.emoji:

emoji_generator: !!python/name:materialx.emoji.to_svg

emoji_index: !!python/name:materialx.emoji.twemoji

- pymdownx.highlight:

anchor_linenums: true

- pymdownx.inlinehilite

- pymdownx.keys

- pymdownx.magiclink:

repo_url_shorthand: true

user: squidfunk

repo: mkdocs-material

- pymdownx.mark

- pymdownx.smartsymbols

- pymdownx.superfences:

- pymdownx.tabbed:

alternate_style: true

- pymdownx.tasklist:

custom_checkbox: true

- pymdownx.tilde

nav:

- PostgresML: index.md

# - Gym: gym.md

- User Guides:

- Setup:

- Quick Start with Docker: user_guides/setup/quick_start_with_docker.md

- Installation:

- v2.0: user_guides/setup/v2/installation.md

- Upgrading from v1.0 to v2.0: user_guides/setup/v2/upgrade-from-v1.md

- v1.0: user_guides/setup/installation.md

- Distributed Training: user_guides/setup/distributed_training.md

- GPU Support: user_guides/setup/gpu_support.md

- Training:

- Training Overview: user_guides/training/overview.md

- Algorithm Selection: user_guides/training/algorithm_selection.md

- Preprocessing Data: user_guides/training/preprocessing.md

- Hyperparameter Search: user_guides/training/hyperparameter_search.md

- Joint Optimization: user_guides/training/joint_optimization.md

- Predictions:

- Prediction Overview: user_guides/predictions/overview.md

- Batch Predictions: user_guides/predictions/batch.md

- Deploying Models: user_guides/predictions/deployments.md

- Vector Operations: user_guides/vector_operations/overview.md

- Transformers:

- Setup: user_guides/transformers/setup.md

- "Pre-Trained Models": user_guides/transformers/pre_trained_models.md

- Fine Tuning: user_guides/transformers/fine_tuning.md

- Dashboard: user_guides/dashboard/overview.md

- Schema:

- Models: user_guides/schema/models.md

- Snapshots: user_guides/schema/snapshots.md

- Projects: user_guides/schema/projects.md

- Deployments: user_guides/schema/deployments.md

- Developer Guide:

- Developer Overview: developer_guide/overview.md

- Blog:

- Data is Living and Relational: blog/data-is-living-and-relational.md

- Postgres Full Text Search is Awesome: blog/postgres-full-text-search-is-awesome.md

- Which Database, That is the Question: blog/which-database-that-is-the-question.md

- Oxidizing Machine Learning: blog/oxidizing-machine-learning.md

- PostgresML is Moving to Rust for our 2.0 Release: blog/postgresml-is-moving-to-rust-for-our-2.0-release.md

- "Backwards Compatible or Bust: Python Inside Rust Inside Postgres": blog/backwards-compatible-or-bust-python-inside-rust-inside-postgres.md

- PostgresML is 8-40x faster than Python HTTP microservices: blog/postgresml-is-8x-faster-than-python-http-microservices.md

- Scaling PostgresML to 1 Million Requests per Second: blog/scaling-postgresml-to-one-million-requests-per-second.md

- About:

- Team: about/team.md

- Roadmap: about/roadmap.md

- Motivation: about/motivation.md

- FAQ: about/faq.md

- License: about/license.md