NotificationsYou must be signed in to change notification settings
Fork328
Star6.4k

Data docs#1418

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

levkk merged 12 commits intomasterfromlevkk-more-docs

Apr 24, 2024

Merged

Data docs#1418

levkk merged 12 commits intomasterfromlevkk-more-docs

Apr 24, 2024

Conversation

Copy link

Contributor

levkk commentedApr 24, 2024•
edited
Loading

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.

levkk added3 commits

April 23, 2024 12:38

tf deployment

eced51a

Moar docs

a5abec1

remove blog post

0c51475

levkk requested a review fromchillenberger

April 24, 2024 16:22

montanalow reviewed

Apr 24, 2024

View reviewed changes

Copy link

Contributor

montanalow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Nice!

pgml-cms/docs/SUMMARY.md

		@@ -50,7 +51,7 @@

		## Product

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

Copy link

Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

This is Cloud as opposed to Vector section

pgml-cms/docs/SUMMARY.md

		@@ -79,7 +80,7 @@
		## Resources

		* [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)

Copy link

Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

This is a dup?

Copy link

ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Not a dup, README.md is currently empty.

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

		@@ -4,11 +4,11 @@ description: Setup a database and connect your application to PostgresML

		# 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.

Copy link

Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

Copy link

ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Both.

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

		* A web application to manage deployed models andhost SQL notebooks
		* PostgreSQL database, with`pgml`, `pgvector`andmany otherextensions installed, including backups, metrics, logs, replicas and high availability
		* PgCatpoolerto provide secure access and model load balancing across thousands of clients
		* A web application to manage deployed models andwrite experiments in SQL notebooks

Copy link

Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

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

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


		##Application SDKs
		##SDK

Copy link

Contributor

montanalowApr 24, 2024•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link

ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

Copy link

ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

It's going to be singular going forward.

Copy link

Contributor

montanalowApr 24, 2024•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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 andSDK 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.

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


		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.

Copy link

Contributor

montanalowApr 24, 2024•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	TheSDK 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.
	TheSDKs 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.

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

		@@ -28,6 +28,8 @@ pip install pgml
		{% 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.

Copy link

Contributor

montanalowApr 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

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


		Useany of these popular tools to execute SQL queries directlyagainst the database:
		If you need to write ad-hoc queries, you can useany of these popular tools to execute SQL queries directlyon your database:

Copy link

Contributor

montanalowApr 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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:

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


		Data that changes infrequently can be easily imported intoPostgresMLusing `COPY`. All you have to do isexport 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 usePostgresMLas your primary database, your job here isdone. You can use the connection credentials provided and start building your application on top of in-database AI right away.

Copy link

Contributor

montanalowApr 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	Ifyou'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.
	Ifyour 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.

pgml-dashboard/src/utils/markdown.rs Outdated

		if let NodeValue::Text(text) = &sibling.data.borrow().value {
		let index = match header_count.get(text) {

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

Copy link

Contributor

montanalowApr 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

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

montanalow reviewed

Apr 24, 2024

View reviewed changes

pgml-cms/docs/SUMMARY.md

		@@ -79,7 +80,7 @@
		## Resources

		* [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)

Copy link

Contributor

montanalowApr 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

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

chillenberger reviewed

Apr 24, 2024

View reviewed changes

Copy link

Contributor

chillenberger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

👍

pgml-dashboard/src/utils/markdown.rs Outdated

		if let NodeValue::Text(text) = &sibling.data.borrow().value {
		let index = match header_count.get(text) {

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

Copy link

Contributor

chillenbergerApr 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Do you want this println in here?

Copy link

ContributorAuthor

levkkApr 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I do not :) good catch

save

f289956

levkk marked this pull request as draft

April 24, 2024 17:09

levkk added8 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 commit82dc23f intomaster

Apr 24, 2024

levkk deleted the levkk-more-docs branch

April 24, 2024 21:43

Labels

None yet

3 participants

Movatterモバイル変換

Data docs#1418

Data docs#1418

Uh oh!

Conversation

levkk commentedApr 24, 2024• editedLoading 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!

montanalowApr 24, 2024• editedLoading 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!

montanalowApr 24, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montanalowApr 24, 2024• editedLoading 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!

Uh oh!

levkk commentedApr 24, 2024•
edited
Loading

montanalowApr 24, 2024•
edited
Loading

montanalowApr 24, 2024•
edited
Loading

montanalowApr 24, 2024•
edited
Loading