6c186c0b6b4646cf89dd48b7298.../README.md
2025-07-31 09:22:31 +00:00

44 lines
1.3 KiB
Markdown

# Linear regression growth prediction
The objective of this calculation is to derive the expected length and depth of anomalies at a
particular date in the future (the target_date) for each matched anomaly in the pipeline.
## Input
### Arguments
- `org_id`: as string which should be a valid `uuid` for the organization
- `project_id`: the id of the data project where the pipeline data is found
- `pipeline_id`: an `array` of `strings` which should each be a valid uuid representing a pipeline.
- `target_date`: a `string` representing the date for which the corrosion growth rate should be predicted.
## Creating the function on the platform
To create this function on the platform using the `cli` set up the port forwarding as shown in README.
Then run the following command to create the function.
```bash
cargo run functions create \
-f functions/acr_linear_regression \
-d "Run the linear regression prediction calculation" \
-i org_id=string \
-i project_id=string \
-i target_date=string \
-i pipeline_id=array
```
## Testing the function locally
You can run and test the function locally by running
```bash
cargo run
```
Then you can check it work with `curl` as follows
```bash
curl localhost:8080 -d $(jq '. | tojson' functions/acr_linear_regression/example_input.json)
```