Skip to content

Commit abb9533

Browse files
Daniel Illenbergergitbook-bot
authored andcommitted
GITBOOK-117: No subject
1 parent 36820c6 commit abb9533

File tree

6 files changed

+368
-38
lines changed

6 files changed

+368
-38
lines changed

pgml-cms/docs/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* [pgml.tune()](introduction/apis/sql-extensions/pgml.tune.md)
3737
* [Client SDKs](introduction/apis/client-sdks/README.md)
3838
* [Overview](introduction/apis/client-sdks/getting-started.md)
39-
* [Collections](introduction/apis/client-sdks/collections.md)
39+
* [Collections](../../pgml-docs/docs/guides/sdks/collections.md)
4040
* [Pipelines](introduction/apis/client-sdks/pipelines.md)
4141
* [Search](introduction/apis/client-sdks/search.md)
4242
* [Tutorials](introduction/apis/client-sdks/tutorials/README.md)

pgml-cms/docs/introduction/apis/sql-extensions/pgml.deploy.md

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ pgml.deploy(
2626

2727
There are 3 different deployment strategies available:
2828

29-
| Strategy | Description |
30-
| ------------- |--------------------------------------------------------------------------------------------------|
31-
| `most_recent` | The most recently trained model for this project is immediately deployed, regardless of metrics. |
32-
| `best_score` | The model that achieved the best key metric score is immediately deployed. |
33-
| `rollback` | The model that was deployed before to the current one is deployed. |
29+
| Strategy | Description |
30+
| ------------- | --------------------------------------------------------------------------------------------------------------------- |
31+
| `most_recent` | The most recently trained model for this project is immediately deployed, regardless of metrics. |
32+
| `best_score` | The model that achieved the best key metric score is immediately deployed. |
33+
| `rollback` | The model that was last deployed for this project is immediately redeployed, overriding the currently deployed model. |
3434

3535
The default deployment behavior allows any algorithm to qualify. It's automatically used during training, but can be manually executed as well:
3636

@@ -40,12 +40,11 @@ The default deployment behavior allows any algorithm to qualify. It's automatica
4040

4141
#### SQL
4242

43-
```sql
44-
SELECT * FROM pgml.deploy(
45-
'Handwritten Digit Image Classifier',
43+
<pre class="language-sql"><code class="lang-sql"><strong>SELECT * FROM pgml.deploy(
44+
</strong> 'Handwritten Digit Image Classifier',
4645
strategy => 'best_score'
4746
);
48-
```
47+
</code></pre>
4948

5049
#### Output
5150

@@ -122,22 +121,3 @@ SELECT * FROM pgml.deploy(
122121
Handwritten Digit Image Classifier | rollback | xgboost
123122
(1 row)
124123
```
125-
126-
### Specific Model IDs
127-
128-
In the case you need to deploy an exact model that is not the `most_recent` or `best_score`, you may deploy a model by id. Model id's can be found in the `pgml.models` table.
129-
130-
#### SQL
131-
132-
```sql
133-
SELECT * FROM pgml.deploy(12);
134-
```
135-
136-
#### Output
137-
138-
```sql
139-
project | strategy | algorithm
140-
------------------------------------+----------+-----------
141-
Handwritten Digit Image Classifier | specific | xgboost
142-
(1 row)
143-
```

pgml-cms/docs/introduction/apis/sql-extensions/pgml.train/data-pre-processing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ In this example:
2525

2626
There are 3 steps to preprocessing data:
2727

28-
* [Encoding](../../../../../../pgml-dashboard/content/docs/training/preprocessing.md#categorical-encodings) categorical values into quantitative values
29-
* [Imputing](../../../../../../pgml-dashboard/content/docs/training/preprocessing.md#imputing-missing-values) NULL values to some quantitative value
30-
* [Scaling](../../../../../../pgml-dashboard/content/docs/training/preprocessing.md#scaling-values) quantitative values across all variables to similar ranges
28+
* [Encoding](data-pre-processing.md#ordinal-encoding) categorical values into quantitative values
29+
* [Imputing](data-pre-processing.md#imputing-missing-values) NULL values to some quantitative value
30+
* [Scaling](data-pre-processing.md#scaling-values) quantitative values across all variables to similar ranges
3131

32-
These preprocessing steps may be specified on a per-column basis to the [train()](../../../../../../docs/training/overview/) function. By default, PostgresML does minimal preprocessing on training data, and will raise an error during analysis if NULL values are encountered without a preprocessor. All types other than `TEXT` are treated as quantitative variables and cast to floating point representations before passing them to the underlying algorithm implementations.
32+
These preprocessing steps may be specified on a per-column basis to the [train()](./) function. By default, PostgresML does minimal preprocessing on training data, and will raise an error during analysis if NULL values are encountered without a preprocessor. All types other than `TEXT` are treated as quantitative variables and cast to floating point representations before passing them to the underlying algorithm implementations.
3333

3434
```sql
3535
SELECT pgml.train(

pgml-cms/docs/resources/developer-docs/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Once there, you can initialize `pgrx` and get going:
6767
#### Pgrx command line and environments
6868

6969
```commandline
70-
cargo install cargo-pgrx --version "0.11.2" --locked && \
70+
cargo install cargo-pgrx --version "0.9.8" --locked && \
7171
cargo pgrx init # This will take a few minutes
7272
```
7373

pgml-cms/docs/resources/developer-docs/installation.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ brew bundle
3636
PostgresML is written in Rust, so you'll need to install the latest compiler from [rust-lang.org](https://rust-lang.org). Additionally, we use the Rust PostgreSQL extension framework `pgrx`, which requires some initialization steps:
3737

3838
```bash
39-
cargo install cargo-pgrx --version 0.11.2 && \
39+
cargo install cargo-pgrx --version 0.9.8 && \
4040
cargo pgrx init
4141
```
4242

@@ -63,7 +63,8 @@ To install the necessary Python packages into a virtual environment, use the `vi
6363
```bash
6464
virtualenv pgml-venv && \
6565
source pgml-venv/bin/activate && \
66-
pip install -r requirements.txt
66+
pip install -r requirements.txt && \
67+
pip install -r requirements-xformers.txt --no-dependencies
6768
```
6869
{% endtab %}
6970

@@ -145,7 +146,7 @@ pgml_test=# SELECT pgml.version();
145146
We like and use pgvector a lot, as documented in our blog posts and examples, to store and search embeddings. You can install pgvector from source pretty easily:
146147

147148
```bash
148-
git clone --branch v0.5.0 https://github.com/pgvector/pgvector && \
149+
git clone --branch v0.4.4 https://github.com/pgvector/pgvector && \
149150
cd pgvector && \
150151
echo "trusted = true" >> vector.control && \
151152
make && \
@@ -287,7 +288,7 @@ We use the `pgrx` Postgres Rust extension framework, which comes with its own in
287288

288289
```bash
289290
cd pgml-extension && \
290-
cargo install cargo-pgrx --version 0.11.2 && \
291+
cargo install cargo-pgrx --version 0.9.8 && \
291292
cargo pgrx init
292293
```
293294

0 commit comments

Comments
 (0)