Skip to content

Commit 75bccda

Browse files
committed
Link to docs from FAQ (#521)
Co-authored-by: Montana Low <montana.low@gmail.com>
1 parent d0e696c commit 75bccda

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

pgml-dashboard/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# PostgresML Dashboard
2+
3+
PostgresML provides a dashboard with analytical views of the training data and model performance, as well as integrated notebooks for rapid iteration. It is primarily written in Rust using [Rocket](https://rocket.rs/) as a lightweight web framework and [SQLx](https://github.com/launchbadge/sqlx) to interact with the database.
4+
5+
Please see the [online documentation](https://postgresml.org/user_guides/setup/quick_start_with_docker/) for general information on installing or deploying PostgresML. This document is intended to help developers set up a local copy of the dashboard.
6+
7+
## Requirements
8+
9+
The dashboard requires a Postgres database with the [pgml-extension](https://github.com/postgresml/postgresml/tree/master/pgml-extension) to generate the core schema. See that subproject for developer setup.
10+
11+
We develop and test this web application on Linux, OS X, and Windows using WSL2.
12+
13+
## Build process
14+
15+
You'll need to specify a database url for the extension to interact with via an environment variable:
16+
17+
```commandline
18+
export DATABASE_URL=postgres://user_name:password@localhost:5432/database_name
19+
```
20+
21+
Build and run:
22+
23+
```commandline
24+
cargo run
25+
```
26+
27+
Incremental and automatic compilation for development cycles is supported with:
28+
29+
```commandline
30+
cargo watch --exec run
31+
```
32+
33+
Run tests:
34+
```commandline
35+
cargo test
36+
```

pgml-docs/docs/about/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Postgres is widely considered mission critical, and some of the most [reliable](
1010

1111
*How good are the models?*
1212

13-
Model quality is often a trade-off between compute resources and incremental quality improvements. Sometimes a few thousands training examples and an off the shelf algorithm can deliver significant business value after a few seconds of training. PostgresML allows stakeholders to choose several different algorithms to get the most bang for the buck, or invest in more computationally intensive techniques as necessary. In addition, PostgresML automatically applies best practices for data cleaning like imputing missing values by default and normalizing data to prevent common problems in production.
13+
Model quality is often a trade-off between compute resources and incremental quality improvements. Sometimes a few thousands training examples and an off the shelf algorithm can deliver significant business value after a few seconds of training. PostgresML allows stakeholders to choose several [different algorithms](/user_guides/training/algorithm_selection/) to get the most bang for the buck, or invest in more computationally intensive techniques as necessary. In addition, PostgresML can automatically apply best practices for [data cleaning](/user_guides/training/preprocessing/)) like imputing missing values by default and normalizing features to prevent common problems in production.
1414

1515
PostgresML doesn't help with reformulating a business problem into a machine learning problem. Like most things in life, the ultimate in quality will be a concerted effort of experts working over time. PostgresML is intended to establish successful patterns for those experts to collaborate around while leveraging the expertise of open source and research communities.
1616

0 commit comments

Comments
 (0)