Data docs #1418

levkk · 2024-04-24T16:19:52Z

Features

Fork @codemirror/lang-sql to add support for Postgres-specific syntax.
Change docs text color to white.
Markdown tables in docs are now .table-sm by default instead of the ugly default bootstrap tables.
Add anchor (link) support for headings/table of contents markdown parser.
Add padding to the bottom of the code block to offset horizontal scrolling bar.

Documentation

Documented logical replication, FDWs, and COPY in data import.

montanalow

Nice!

montanalow · 2024-04-24T16:37:32Z

pgml-cms/docs/SUMMARY.md


 ## Product

-* [Cloud Database](product/cloud-database/README.md)


This is Cloud as opposed to Vector section

montanalow · 2024-04-24T16:37:52Z

pgml-cms/docs/SUMMARY.md


 * [FAQs](resources/faqs.md)
-* [Data Storage & Retrieval](resources/data-storage-and-retrieval/README.md)
+* [Data Storage & Retrieval](resources/data-storage-and-retrieval/tabular-data.md)


This is a dup?

Not a dup, README.md is currently empty.

montanalow · 2024-04-24T16:38:45Z

pgml-cms/docs/introduction/getting-started/README.md

 # Getting Started

-A PostgresML deployment consists of multiple components working in concert to provide a complete Machine Learning platform. We provide a fully managed solution in our cloud.
+A PostgresML deployment consists of multiple components working in concert to provide a complete Machine Learning platform. We provide a fully managed solution in our cloud, and document a self-hosted installation in our docs.


documenting the self hosted version is confusing here. Are these docs for cloud users, or self hosted people?

montanalow · 2024-04-24T16:39:38Z

pgml-cms/docs/introduction/getting-started/README.md

-* A web application to manage deployed models and host SQL notebooks
+* PostgreSQL database, with `pgml`, `pgvector` and many other extensions installed, including backups, metrics, logs, replicas and high availability
+* PgCat pooler to provide secure access and model load balancing across thousands of clients
+* A web application to manage deployed models and write experiments in SQL notebooks


Suggested change

* A web application to manage deployed models and write experiments in SQL notebooks

* A web application to manage deployed models and share experiments and analysis in SQL notebooks

montanalow · 2024-04-24T16:40:48Z

pgml-cms/docs/introduction/getting-started/connect-your-app.md

+You can connect to your database from any PostgresSQL-compatible client. PostgresML is intended to serve in the traditional role of an application database, along with it's extended role as an MLOps platform to make it easy to build and maintain AI applications together with your application data.

-## Application SDKs
+## SDK


Suggested change

## SDK

## Client SDKs

We've waffled between singular and plural. If we want to change to singular, we'll need to update in several other places, including urls.

Not going to write Client SDKs ever again, that wording is just wrong. SDK are only usable on the client by definition.

It's going to be singular going forward.

New PRs should use the existing style guide, for code or copy. We should make that update globally in a separate PR to preserve consistency.

Dealing with the separate issue, many users frequently ask about the difference between the SDK and Extension, and how they interact. I think you're confused about the difference between and SDK and API as commonly used, but those terms are not always 100% consistently used in industry, so we need some additional education about how we're using them.

montanalow · 2024-04-24T16:41:44Z

pgml-cms/docs/introduction/getting-started/connect-your-app.md

+We provide a client SDK for JavaScript, Python and Rust. The SDK manages connections to the Postgres database and makes it easy to construct efficient queries for AI use cases, like managing a document collection for RAG, or building a chatbot. All of the ML & AI still happenening inside the database, with centralized operations, hardware and dependency management.

-These SDKs are under rapid development to add new features and use cases, but we release non breaking changes with minor version updates in accordance with SemVer. It's easy to install into your existing application.
+The SDK are under rapid development to add new features and use cases, but we release non breaking changes with minor version updates in accordance with SemVer. It's easy to install into your existing application.


Suggested change

The SDK are under rapid development to add new features and use cases, but we release non breaking changes with minor version updates in accordance with SemVer. It's easy to install into your existing application.

The SDKs are under rapid development to add new features and use cases, but we release non breaking changes with minor version updates in accordance with SemVer. It's easy to install into your existing application.

montanalow · 2024-04-24T16:43:00Z

pgml-cms/docs/introduction/getting-started/connect-your-app.md

 {% endtab %}
 {% endtabs %}

+Our SDK comes with zero additional dependencies. The core of the SDK is written in Rust, and we provide language bindings and native packaging & distribution.


Suggested change

Our SDK comes with zero additional dependencies. The core of the SDK is written in Rust, and we provide language bindings and native packaging & distribution.

Our SDK comes with zero additional dependencies, to provide the simplest and safest ML application deployment and maintenance possible. The core of the SDK is written in Rust, and we provide language bindings and native packaging & distribution.

montanalow · 2024-04-24T16:44:22Z

pgml-cms/docs/introduction/getting-started/connect-your-app.md

+## SQL editors

-Use any of these popular tools to execute SQL queries directly against the database:
+If you need to write ad-hoc queries, you can use any of these popular tools to execute SQL queries directly on your database:


Suggested change

If you need to write ad-hoc queries, you can use any of these popular tools to execute SQL queries directly on your database:

If you need to write ad-hoc queries, or perform administrative functions, you can use any of these popular tools to execute SQL queries directly on your database:

montanalow · 2024-04-24T16:45:57Z

pgml-cms/docs/introduction/getting-started/import-your-data/README.md

+## Primary database

-Data that changes infrequently can be easily imported into PostgresML using `COPY`. All you have to do is export your data as a CSV file, create a table in Postgres to store it, and import it using the command line.
+If you're intention is to use PostgresML as your primary database, your job here is done. You can use the connection credentials provided and start building your application on top of in-database AI right away.


Suggested change

If you're intention is to use PostgresML as your primary database, your job here is done. You can use the connection credentials provided and start building your application on top of in-database AI right away.

If your intention is to use PostgresML as your primary database, your job here is done. You can use the connection credentials provided and start building your application on top of in-database AI right away.

montanalow · 2024-04-24T16:47:04Z

pgml-dashboard/src/utils/markdown.rs

-                if let NodeValue::Text(text) = &sibling.data.borrow().value {
-                    let index = match header_count.get(text) {
+
+                println!("child: {:?}", sibling);


Suggested change

println!("child: {:?}", sibling);

montanalow · 2024-04-24T16:47:53Z

pgml-cms/docs/SUMMARY.md

 * [FAQs](resources/faqs.md)
-* [Data Storage & Retrieval](resources/data-storage-and-retrieval/README.md)
+* [Data Storage & Retrieval](resources/data-storage-and-retrieval/tabular-data.md)
  * [Tabular data](resources/data-storage-and-retrieval/tabular-data.md)


Suggested change

* [Tabular data](resources/data-storage-and-retrieval/tabular-data.md)

chillenberger

👍

chillenberger · 2024-04-24T16:26:32Z

pgml-dashboard/src/utils/markdown.rs

-                if let NodeValue::Text(text) = &sibling.data.borrow().value {
-                    let index = match header_count.get(text) {
+
+                println!("child: {:?}", sibling);


Do you want this println in here?

I do not :) good catch

levkk added 3 commits April 23, 2024 12:38

tf deployment

eced51a

Moar docs

a5abec1

remove blog post

0c51475

levkk requested a review from chillenberger April 24, 2024 16:22

montanalow reviewed Apr 24, 2024

View reviewed changes

chillenberger reviewed Apr 24, 2024

View reviewed changes

save

f289956

levkk marked this pull request as draft April 24, 2024 17:09

levkk added 8 commits April 24, 2024 14:28

more

cd61aaa

word

17a1072

intro

941bed3

cloud

1cf3c81

ok

1cc71ed

spell

4ce5467

typo

4d7f7c2

spell

7f6e676

levkk marked this pull request as ready for review April 24, 2024 21:43

levkk merged commit 82dc23f into master Apr 24, 2024

levkk deleted the levkk-more-docs branch April 24, 2024 21:43


		## Product

		* [Cloud Database](product/cloud-database/README.md)

	* A web application to manage deployed models and write experiments in SQL notebooks
	* A web application to manage deployed models and share experiments and analysis in SQL notebooks

	The SDK are under rapid development to add new features and use cases, but we release non breaking changes with minor version updates in accordance with SemVer. It's easy to install into your existing application.
	The SDKs are under rapid development to add new features and use cases, but we release non breaking changes with minor version updates in accordance with SemVer. It's easy to install into your existing application.

	Our SDK comes with zero additional dependencies. The core of the SDK is written in Rust, and we provide language bindings and native packaging & distribution.
	Our SDK comes with zero additional dependencies, to provide the simplest and safest ML application deployment and maintenance possible. The core of the SDK is written in Rust, and we provide language bindings and native packaging & distribution.

	If you need to write ad-hoc queries, you can use any of these popular tools to execute SQL queries directly on your database:
	If you need to write ad-hoc queries, or perform administrative functions, you can use any of these popular tools to execute SQL queries directly on your database:

	If you're intention is to use PostgresML as your primary database, your job here is done. You can use the connection credentials provided and start building your application on top of in-database AI right away.
	If your intention is to use PostgresML as your primary database, your job here is done. You can use the connection credentials provided and start building your application on top of in-database AI right away.

Data docs #1418

Data docs #1418

Uh oh!

Conversation

levkk commented Apr 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Features

Documentation

Uh oh!

montanalow left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montanalow Apr 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montanalow Apr 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montanalow Apr 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chillenberger left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

levkk commented Apr 24, 2024 •

edited

Loading

montanalow Apr 24, 2024 •

edited

Loading

montanalow Apr 24, 2024 •

edited

Loading

montanalow Apr 24, 2024 •

edited

Loading