You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Getting Started/Getting Started with FastScore/index.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -228,7 +228,7 @@ This will install the required dependencies. The FastScore CLI is a Python tool,
228
228
> ```
229
229
230
230
231
-
Once you've installed the FastScore CLI, check that it works by executing the following commandin your terminal. Also see [FastScore Command Line Interface](https://opendatagroup.github.io/Product%20Documentation/FastScore%20Command%20Line%20Interface.html) for more information on subcommands.
231
+
Once you've installed the FastScore CLI, check that it works by executing the following commandin your terminal. Also see [FastScore Command Line Interface](https://opendatagroup.github.io/Reference/FastScore%20CLI/) for more information on subcommands.
232
232
233
233
``` bash
234
234
$ fastscore help
@@ -427,7 +427,7 @@ def end():
427
427
pass
428
428
```
429
429
430
-
This model returns the sum of two numbers. Note that we are able to import Python's standard modules, such as the `pickle` module. Non-default packages can also be added using [Import Policies, as described here](https://opendatagroup.github.io/Product%20Documentation/Import%20Policies.html). Custom classes and packages can be loaded using attachments, as described in the [Gradient Boosting Regressor tutorial](https://opendatagroup.github.io/Examples%20and%20Tutorials/Gradient%20Boosting%20Regressor.html).
430
+
This model returns the sum of two numbers. Note that we are able to import Python's standard modules, such as the `pickle` module. Non-default packages can also be added using [Import Policies, as described here](https://opendatagroup.github.io/Product%20Manuals/Import%20Policies/). Custom classes and packages can be loaded using attachments, as described in the [Gradient Boosting Regressor tutorial](https://opendatagroup.github.io/Knowledge%20Center/Tutorials/Gradient%20Boosting%20Regressor/).
431
431
432
432
#### R Models
433
433
R models feature much of the same functionality as Python models, as well as the same constraint: the user must define an action functionto perform the actual scoring. For example, the analogous model to the Python model above is
@@ -505,7 +505,7 @@ Stream Descriptors are small JSON files containing information about the stream.
505
505
}
506
506
```
507
507
508
-
Stream descriptors are documented in more detail [on the stream descriptor page](stream-descriptors). The easiest type of stream to use is a file stream, which reads or writes records directly from/to a file inside of the FastScore engine container. Here is an example of such a stream:
508
+
Stream descriptors are documented in more detail [on the stream descriptor page](https://opendatagroup.github.io/Product%20Manuals/Stream%20Descriptors/). The easiest type of stream to use is a file stream, which reads or writes records directly from/to a file inside of the FastScore engine container. Here is an example of such a stream:
509
509
510
510
``` json
511
511
{
@@ -603,4 +603,4 @@ To run a model using the FastScore CLI, use the `fastscore job` sequence of comm
603
603
*`fastscore job status` and `fastscore job statistics` display various information about the currently running job.
604
604
Some of the statistics displayed by the `fastscore job statistics` command, such as memory usage, are also shown on the Dashboard.
605
605
606
-
This concludes the FastScore Getting Started guide. Additional FastScore API documentation is available at [https://opendatagroup.github.io/API/](https://opendatagroup.github.io/API/). Happy scoring!
606
+
This concludes the FastScore Getting Started guide. Additional FastScore API documentation is available at [https://opendatagroup.github.io/Reference/FastScore%20API/](https://opendatagroup.github.io/Reference/FastScore%20API/). Happy scoring!
Copy file name to clipboardExpand all lines: Knowledge Center/Tutorials/Gradient Boosting Regressor/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -202,7 +202,7 @@ Loading our GBR model to FastScore can be broken into two steps: preparing the m
202
202
203
203
In the previous section, we created a small Python script to score our incoming auto records using the trained gradient boosting regressor and our custom feature transformer. In this example, the training of the model has already been done, so we'll only need to adapt the trained model to produce scores.
204
204
205
-
As discussed in the [Getting Started Guide](https://opendatagroup.github.io/Guides/Getting%20Started%20with%20FastScore%20v1-6-1.html), Python models in FastScore must deliver scores using an `action` method. Note that the `action` method operates as a generator, so scores are obtained from `yield` statements, rather than `return` statements. Additionally, because we don't want to re-load our trained model with every score, we'll define a `begin` method to do all of the model initialization. If a model defines a `begin` method, this method will be called at the start of the job.
205
+
As discussed in the [Getting Started Guide](https://opendatagroup.github.io/Getting%20Started/Getting%20Started%20with%20FastScore/), Python models in FastScore must deliver scores using an `action` method. Note that the `action` method operates as a generator, so scores are obtained from `yield` statements, rather than `return` statements. Additionally, because we don't want to re-load our trained model with every score, we'll define a `begin` method to do all of the model initialization. If a model defines a `begin` method, this method will be called at the start of the job.
206
206
207
207
After these alterations, our model looks like this:
208
208
@@ -315,7 +315,7 @@ The input stream descriptor includes the more complicated schema, encapsulating
315
315
316
316
### Starting and Configuring FastScore
317
317
318
-
This step may differ if you're using a custom FastScore deployment. If you're just using the [standard deployment from the Getting Started Guide](https://opendatagroup.github.io/Guides/Getting%20Started%20with%20FastScore%20v1-6-1.html#section-start-fastscore-microservices-suite-with-docker-compose-recommended-), starting up FastScore is as easy as executing the following command:
318
+
This step may differ if you're using a custom FastScore deployment. If you're just using the [standard deployment from the Getting Started Guide](https://opendatagroup.github.io/Getting%20Started/Getting%20Started%20with%20FastScore/), starting up FastScore is as easy as executing the following command:
319
319
320
320
```bash
321
321
docker-compose up -d
@@ -415,7 +415,7 @@ fastscore model add GBM score_auto_gbm.py
415
415
fastscore attachment upload GBM gbm.tar.gz
416
416
```
417
417
418
-
Steps for setting configuration through the Dashboard are covered in the [Getting Started Guide](https://opendatagroup.github.io/Guides/Getting%20Started%20with%20FastScore%20v1-6-1.html#section-using-the-fastscore-dashboard).
418
+
Steps for setting configuration through the Dashboard are covered in the [Getting Started Guide](https://opendatagroup.github.io/Getting%20Started/Getting%20Started%20with%20FastScore/#section-using-the-fastscore-dashboard).
419
419
420
420
After adding the model, attachment, and streams to FastScore, you can inspect them from the FastScore Dashboard:
Copy file name to clipboardExpand all lines: Product Manuals/Import Policies/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,4 +44,4 @@ A model runner's import policy manifest is loaded from the `import.policy` file
44
44
45
45
In FastScore 1.4, the import policy for a model runner is fixed as soon as a model is loaded into the engine, so any changes to import policies must be made _before_ running a model. To copy a new manifest into the container, use the [`docker cp`](https://docs.docker.com/engine/reference/commandline/cp/) command or an equivalent.
46
46
47
-
Adding import policies to an engine through the command `fastscore policy set my-policy.yml` is now available with v1.6. See [FastScore Command Line Interface](https://opendatagroup.github.io/Product%20Documentation/FastScore%20Command%20Line%20Interface.html) for more information on subcommands.
47
+
Adding import policies to an engine through the command `fastscore policy set my-policy.yml` is now available with v1.6. See [FastScore Command Line Interface](https://opendatagroup.github.io/Reference/FastScore%20CLI/) for more information on subcommands.
Copy file name to clipboardExpand all lines: Product Manuals/LDAP Authentication/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Starting with FastScore v1.4, the FastScore Dashboard and Proxy support Microsof
11
11
12
12
This section assumes you already possess an existing Vault service. If you haven't configured Vault yet, [read the Vault configuration section below](#configuring-vault-in-docker).
13
13
14
-
Authentication in FastScore is achieved through the Dashboard service. Recall from the [Getting Started Guide](https://opendatagroup.github.io/Guides/Getting%20Started%20with%20FastScore%20v1-6-1.html) that Dashboard is designed to serve as a proxy for the FastScore fleet's REST API, as well as a visual configuration and diagnostic aid. By default, authentication is not enabled in Dashboard. To enable it, set the following environment variables:
14
+
Authentication in FastScore is achieved through the Dashboard service. Recall from the [Getting Started Guide](https://opendatagroup.github.io/Getting%20Started/Getting%20Started%20with%20FastScore/) that Dashboard is designed to serve as a proxy for the FastScore fleet's REST API, as well as a visual configuration and diagnostic aid. By default, authentication is not enabled in Dashboard. To enable it, set the following environment variables:
Copy file name to clipboardExpand all lines: Product Manuals/Schema Reference/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ excerpt: ""
8
8
9
9
FastScore enforces strict typing of engine inputs and outputs at two levels: stream input/output, and model input/output. Types are declared using [AVRO schema](https://avro.apache.org/docs/1.8.1/).
10
10
11
-
To support this functionality, FastScore's Model Manage maintains a database of named AVRO schemas. Python and R models must then reference their input and output schemas using smart comments. (PrettyPFA and PFA models instead explicitly include their AVRO types as part of the model format.) [Stream descriptors](https://opendatagroup.github.io/Product%20Documentation/Stream%20Descriptors.html) may either reference a named schema from Model Manage, or they may explicitly declare schemas.
11
+
To support this functionality, FastScore's Model Manage maintains a database of named AVRO schemas. Python and R models must then reference their input and output schemas using smart comments. (PrettyPFA and PFA models instead explicitly include their AVRO types as part of the model format.) [Stream descriptors](https://opendatagroup.github.io/Product%20Manuals/Stream%20Descriptors/) may either reference a named schema from Model Manage, or they may explicitly declare schemas.
12
12
13
13
In either case, FastScore performs the following type checks:
14
14
@@ -66,13 +66,13 @@ and score this record to produce
66
66
{"name":"Bob", "product":"6.0"}
67
67
```
68
68
69
-
[Once FastScore is running](https://opendatagroup.github.io/Guides/Getting%20Started%20with%20FastScore%20v1-6-1.html), we can add the model and associated schemas to model manage with the following commands:
69
+
[Once FastScore is running](https://opendatagroup.github.io/Getting%20Started/Getting%20Started%20with%20FastScore/), we can add the model and associated schemas to model manage with the following commands:
Assuming that additionally, we have [configured the input and output stream descriptors](https://opendatagroup.github.io/Product%20Documentation/Stream%20Descriptors.html) to use our schemas, we can then run the job with
75
+
Assuming that additionally, we have [configured the input and output stream descriptors](https://opendatagroup.github.io/Product%20Manuals/Stream%20Descriptors/) to use our schemas, we can then run the job with
76
76
```
77
77
fastscore job run my_model <input stream name> <output stream name>
The `snapshot list` command shows the saved snapshots for a given model. The `snapshot restore` command restores the specified snapshot for a particular model. Snapshots are automatically created upon receipt of an end-of-stream message, but these end-of-stream messages can be introduced as control records into the data stream for streaming transports (e.g. Kafka). For more information on control records, see [Record Sets and Control Records](https://opendatagroup.github.io/Product%20Documentation/Record%20Sets%20and%20Control%20Records.html).
96
+
The `snapshot list` command shows the saved snapshots for a given model. The `snapshot restore` command restores the specified snapshot for a particular model. Snapshots are automatically created upon receipt of an end-of-stream message, but these end-of-stream messages can be introduced as control records into the data stream for streaming transports (e.g. Kafka). For more information on control records, see [Record Sets and Control Records](https://opendatagroup.github.io/Product%20Manuals/Record%20Sets%20and%20Control%20Records/).
97
97
98
98
To enable snapshots, use the `fastscore.snapshots` smart comment:
0 commit comments