Skip to content

Dan doc landing page #1320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 29 commits into from
Feb 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
8e5ea4d
start of docs layout, docs page, refactor side nave into a componnet,…
chillenberger Feb 6, 2024
4c35e87
make left nave in docs look nice
chillenberger Feb 7, 2024
0a2c53e
fix expand arrow rotation
chillenberger Feb 8, 2024
42943da
doc landing page article cards, alt cards, typeography bug fix, p def…
chillenberger Feb 10, 2024
b945282
add card rounded border and fix layout container overflow
chillenberger Feb 10, 2024
f2e79fb
add descriptions to docs cms meta
chillenberger Feb 10, 2024
f240230
split doc render out of collection render, add left nave to doc artic…
chillenberger Feb 13, 2024
414428c
clean up doc left nave icon map method
chillenberger Feb 13, 2024
abe1987
highlight open article on docs left nav
chillenberger Feb 13, 2024
0b3cb54
add feature banner to doc article, fmt
chillenberger Feb 13, 2024
b1ac66a
move doc glow to layout, add feature banner to doc landing page
chillenberger Feb 13, 2024
05030c8
add FAQ accordian to landing page, move accordian styling, add defaul…
chillenberger Feb 13, 2024
c26ba7b
Merge branch 'master' into dan-doc-landing-page
chillenberger Feb 13, 2024
7af3034
add Have Questions section, make it a component
chillenberger Feb 13, 2024
a4c907c
Wrap tables for overflow
chillenberger Feb 13, 2024
ee65284
make search button component and add to doc landing page.
chillenberger Feb 14, 2024
c8edd01
left nave index styles
chillenberger Feb 15, 2024
8eee967
TOC, cleanup scrollbars
chillenberger Feb 16, 2024
da31bef
remove index from careers and blog
chillenberger Feb 16, 2024
6c54122
Merge branch 'master' into dan-doc-landing-page
chillenberger Feb 16, 2024
b010a36
remove blog left nave code since it is no longer used
chillenberger Feb 17, 2024
0bd9a30
change /docs/ to /docs
chillenberger Feb 20, 2024
a90e7cf
fix doc parse test
chillenberger Feb 20, 2024
597f6af
text wrap rather than ellipse on text overflow, index expand arrow al…
chillenberger Feb 20, 2024
4275b8d
make card order same as file order, find missing benchmark article
chillenberger Feb 20, 2024
160b152
Update docs.scss fmt
chillenberger Feb 20, 2024
254fd0b
clean up doc layout glow container
chillenberger Feb 20, 2024
f82f5e8
Merge branch 'dan-doc-landing-page' of https://github.com/postgresml/…
chillenberger Feb 20, 2024
3de853b
new lines, remove dead code, comment fix
chillenberger Feb 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pgml-cms/docs/introduction/apis/client-sdks/collections.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: >-
Organizational building blocks of the SDK. Manage all documents and related chunks, embeddings, tsvectors, and pipelines.
---
# Collections

Collections are the organizational building blocks of the SDK. They manage all documents and related chunks, embeddings, tsvectors, and pipelines.
Expand Down
4 changes: 4 additions & 0 deletions pgml-cms/docs/introduction/apis/client-sdks/pipelines.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: >-
Pipelines are composed of a model, splitter, and additional optional arguments.
---
# Pipelines

Pipelines are composed of a Model, Splitter, and additional optional arguments. Collections can have any number of Pipelines. Each Pipeline is ran everytime documents are upserted.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: >-
JavaScript and Python code snippets for end-to-end question answering.
---
# Extractive Question Answering

Here is the documentation for the JavaScript and Python code snippets performing end-to-end question answering:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: >-
JavaScript and Python code snippets for using instructor models in more advanced search use cases.
---
# Semantic Search using Instructor model

This shows using instructor models in the `pgml` SDK for more advanced use cases.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: >-
JavaScript and Python code snippets for text summarization.
---
# Summarizing Question Answering

Here are the Python and JavaScript examples for text summarization using `pgml` SDK
Expand Down
5 changes: 5 additions & 0 deletions pgml-cms/docs/introduction/apis/sql-extensions/pgml.deploy.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
description: >-
Release trained models when ML quality metrics computed during training improve. Track model deployments over time and rollback if needed.
---

# pgml.deploy()

## Deployments
Expand Down
5 changes: 5 additions & 0 deletions pgml-cms/docs/introduction/apis/sql-extensions/pgml.embed.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
description: >-
Generate high quality embeddings with faster end-to-end vector operations without an additional vector database.
---

# pgml.embed()

Embeddings are a numeric representation of text. They are used to represent words and sentences as vectors, an array of numbers. Embeddings can be used to find similar pieces of text, by comparing the similarity of the numeric vectors using a distance measure, or they can be used as input features for other machine learning models, since most algorithms can't use text directly.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
description: >-
Batch predict from data in a table. Online predict with parameters passed in a query. Automatically reuse pre-processing steps from training.
---

# pgml.predict()

## API
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
description: >-
The training function is at the heart of PostgresML. It's a powerful single
mechanism that can handle many different training tasks which are configurable
with the function parameters.
Pre-process and pull data to train a model using any of 50 different ML algorithms.
---

# pgml.train()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
description: >-
Perform dozens of state-of-the-art natural language processing (NLP) tasks with thousands of models. Serve with the same Postgres infrastructure.
layout:
title:
visible: true
Expand Down
5 changes: 5 additions & 0 deletions pgml-cms/docs/introduction/apis/sql-extensions/pgml.tune.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
description: >-
Fine tune open-source models on your own data.
---

# pgml.tune()

## Fine Tuning
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: >-
Quantization allows PostgresML to fit larger models in less RAM.
---
# GGML Quantized LLM support for Huggingface Transformers


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: >-
Anyone who runs Postgres at scale knows that performance comes with trade offs.
---
# Making Postgres 30 Percent Faster in Production

Anyone who runs Postgres at scale knows that performance comes with trade offs. The typical playbook is to place a pooler like PgBouncer in front of your database and turn on transaction mode. This makes multiple clients reuse the same server connection, which allows thousands of clients to connect to your database without causing a fork bomb.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: >-
The question "Does it Scale?" has become somewhat of a meme in software engineering.
---
# Million Requests per Second

The question "Does it Scale?" has become somewhat of a meme in software engineering. There is a good reason for it though, because most businesses plan for success. If your app, online store, or SaaS becomes popular, you want to be sure that the system powering it can serve all your new customers.
Expand Down
4 changes: 4 additions & 0 deletions pgml-cms/docs/resources/benchmarks/mindsdb-vs-postgresml.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: >-
Compare two projects that both aim
to provide an SQL interface to ML algorithms and the data they require.
---
# MindsDB vs PostgresML

## Introduction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: >-
PostgresML is a simpler alternative to that ever-growing complexity.
---
# PostgresML is 8-40x faster than Python HTTP microservices

Machine learning architectures can be some of the most complex, expensive and _difficult_ arenas in modern systems. The number of technologies and the amount of required hardware compete for tightening headcount, hosting, and latency budgets. Unfortunately, the trend in the industry is only getting worse along these lines, with increased usage of state-of-the-art architectures that center around data warehouses, microservices and NoSQL databases.
Expand Down
Loading