> ## Documentation Index
> Fetch the complete documentation index at: https://docs.graphext.com/llms.txt
> Use this file to discover all available pages before exploring further.

# scale

> Scales the values of a numerical column to lie between a specified minimum and maximum. 

Without further specification, the minimum and maximum by default are 0.0 and 1.0 respectively.

## Usage

The following examples show how the step can be used in a recipe.

<Accordion title="Examples" icon="code" defaultOpen="true">
  <Tabs>
    <Tab title="Example 1">
      The following example scales input values to be in the range \[0, 1].

      ```stan theme={null}
      scale(ds.input) -> (ds.scaled)
      ```
    </Tab>

    <Tab title="Example 2">
      Using a custom configuration to scale values to the interval \[-2, 2], rather than the default of \[0, 1]:

      ```stan theme={null}
      scale(ds.input, {
        "min": -2,
        "max": 2,
      }) -> (ds.scaled)
      ```
    </Tab>

    <Tab title="Signature">
      General syntax for using the step in a recipe. Shows the inputs and outputs the step is expected to receive and will produce respectively. For futher details see sections below.

      ```stan theme={null}
      scale(input: number, {
          "param": value,
          ...
      }) -> (output: number)
      ```
    </Tab>
  </Tabs>
</Accordion>

## Inputs & Outputs

The following are the inputs expected by the step and the outputs it produces. These are generally
columns (`ds.first_name`), datasets (`ds` or `ds[["first_name", "last_name"]]`) or models (referenced
by name e.g. `"churn-clf"`).

<Accordion title="Inputs" icon="right-to-bracket">
  <ParamField path="input" type="column[number]" required>
    A numeric input column.
  </ParamField>
</Accordion>

<Accordion title="Outputs" icon="right-from-bracket">
  <ParamField path="output" type="column[number]" required>
    A numeric column containing the scaled values.
  </ParamField>
</Accordion>

## Configuration

The following parameters can be used to configure the behaviour of the step by including them in
a json object as the last "input" to the step, i.e. `step(..., {"param": "value", ...}) -> (output)`.

<Accordion title="Parameters" defaultOpen="true" icon="sliders">
  <ParamField path="min" type="number" default="0.0">
    The minimum value after scaling.
  </ParamField>

  <ParamField path="max" type="number" default="1.0">
    The maximum value after scaling.
  </ParamField>
</Accordion>