pyoframe 1.0.0a0__tar.gz → 1.1.0__tar.gz

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/.github/actions/setup_optimizers_linux/action.yml

@@ -8,9 +8,12 @@ inputs:
   GUROBI_WLS:
     description: "..."
     required: true
-  # COPT_CLIENT_INI:
-  #   description: "..."
-  #   required: true
+  COPT_LICENSE_KEY:
+    description: "..."
+    required: true
+  COPT_LICENSE_DAT:
+    description: "..."
+    required: true
   # MOSEK_LICENSE:
   #   description: "..."
   #   required: true
@@ -46,8 +49,7 @@ runs:
       run: |
         curl -L -o ~/installers/gurobi.tar.gz https://packages.gurobi.com/12.0/gurobi12.0.2_linux64.tar.gz
         curl -L -o ~/installers/idaes-solvers.tar.gz https://github.com/IDAES/idaes-ext/releases/download/3.4.2/idaes-solvers-ubuntu2204-x86_64.tar.gz
-
-    # curl -L -o ~/installers/copt.tar.gz https://pub.shanshu.ai/download/copt/7.2.8/linux64/CardinalOptimizer-7.2.8-lnx64.tar.gz
+        curl -L -o ~/installers/copt.tar.gz https://pub.shanshu.ai/download/copt/7.2.11/linux64/CardinalOptimizer-7.2.11-lnx64.tar.gz
     # curl -L -o ~/installers/mosek.tar.bz2 https://download.mosek.com/stable/10.2.0/mosektoolslinux64x86.tar.bz2
 
     - name: Setup Gurobi Installation
@@ -76,28 +78,28 @@ runs:
         timeout_minutes: 1
         command: gurobi_cl
 
-    # - name: Setup COPT Installation
-    #   shell: bash
-    #   env:
-    #     COPT_CLIENT_INI: ${{ inputs.COPT_CLIENT_INI }}
-    #   run: |
-    #     tar xfz ~/installers/copt.tar.gz -C ~/
-    #     ls ~/copt72
-    #     # set environment variables
-    #     export COPT_HOME="${HOME}/copt72"
-    #     echo "COPT_HOME=${COPT_HOME}" >> $GITHUB_ENV
-    #     echo "PATH=${PATH}:${COPT_HOME}/bin" >> $GITHUB_ENV
-    #     echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${COPT_HOME}/lib" >> $GITHUB_ENV
-    #     echo $COPT_HOME
-
-    #     # Just use the size-limited license
-    #     # echo "$COPT_CLIENT_INI" > ~/client.ini
-    #     # echo "COPT_LICENSE_DIR=${HOME}" >> $GITHUB_ENV
-    # - name: Test COPT
-    #   if: ${{ inputs.CHECK_LICENSE == 'true' }}
-    #   shell: bash
-    #   run: |
-    #     copt_cmd -c "quit"
+    - name: Setup COPT Installation
+      shell: bash
+      env:
+        COPT_LICENSE_KEY: ${{ inputs.COPT_LICENSE_KEY }}
+        COPT_LICENSE_DAT: ${{ inputs.COPT_LICENSE_DAT }}
+      run: |
+        tar xfz ~/installers/copt.tar.gz -C ~/
+        ls ~/copt72
+        # set environment variables
+        export COPT_HOME="${HOME}/copt72"
+        echo "COPT_HOME=${COPT_HOME}" >> $GITHUB_ENV
+        echo "PATH=${PATH}:${COPT_HOME}/bin" >> $GITHUB_ENV
+        echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${COPT_HOME}/lib" >> $GITHUB_ENV
+        echo $COPT_HOME
+        echo "$COPT_LICENSE_KEY" > ${COPT_HOME}/license.key
+        echo "$COPT_LICENSE_DAT" > ${COPT_HOME}/license.dat
+        echo "COPT_LICENSE_DIR=${COPT_HOME}" >> $GITHUB_ENV
+    - name: Test COPT
+      if: ${{ inputs.CHECK_LICENSE == 'true' }}
+      shell: bash
+      run: |
+        copt_cmd -c "quit"
 
     # - name: Setup MOSEK Installation
     #   shell: bash

pyoframe-1.1.0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "17:00"
+  allow:
+    - dependency-type: production
+    - dependency-name: highsbox
+    - dependency-name: llvmlite

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/.github/workflows/ci.yml

@@ -45,9 +45,9 @@ jobs:
           username: ${{ github.triggering_actor }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      # If neither has permissions and no 'safe to test' label throw error
+      # If neither has permissions and no 'safe to test' label and not dependabot throw error
       - name: Check User Permission
-        if: steps.checkAccess.outputs.require-result == 'false' && steps.checkTriggeringAccess.outputs.require-result == 'false' && !contains(github.event.pull_request.labels.*.name, 'safe to test')
+        if: steps.checkAccess.outputs.require-result == 'false' && steps.checkTriggeringAccess.outputs.require-result == 'false' && !contains(github.event.pull_request.labels.*.name, 'safe to test') && (github.actor != 'dependabot[bot]')
         shell: bash
         run: |
           echo "${{ github.triggering_actor }} does not have permissions on this repo."
@@ -55,7 +55,8 @@ jobs:
           exit 1
   run:
     if: |
-      (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository) || 
+      (github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]') ||
+      (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && github.actor != 'dependabot[bot]') || 
       (github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.full_name != github.repository) || 
       (github.event_name != 'pull_request_target' && github.event_name != 'pull_request')
     runs-on: ubuntu-latest
@@ -80,12 +81,15 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           cache: "pip"
-      - name: Install dependencies
-        run: pip install -e .[dev]
-      - uses: ./.github/actions/setup_optimizers_linux
+      - name: Setup optimizers
+        uses: ./.github/actions/setup_optimizers_linux
         with:
           GUROBI_WLS: ${{ secrets.GUROBI_WLS }}
+          COPT_LICENSE_KEY: ${{ secrets.COPT_LICENSE_KEY }}
+          COPT_LICENSE_DAT: ${{ secrets.COPT_LICENSE_DAT }}
           CHECK_LICENSE: true
+      - name: Install dependencies
+        run: pip install -e .[dev]
       - name: Run tests and collect coverage
         run: pytest --cov
       - name: Upload coverage to Codecov

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/.gitignore

@@ -13,4 +13,4 @@ site
 .idea
 src/pyoframe/_version.py
 htmlcov/
-.snakemake
+.snakemake/

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/.pre-commit-config.yaml

@@ -12,4 +12,4 @@ repos:
     rev: v2025.4.8
     hooks:
     -   id: doccmd
-        args: ["--language", "python", "--no-pad-file", "--command", "ruff format", "docs/"]
+        args: ["--language", "python", "--no-pad-file", "--no-use-pty", "--command", "ruff format", "docs/"]

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: pyoframe
-Version: 1.0.0a0
+Version: 1.1.0
 Summary: Blazing fast linear program interface
 Author-email: Bravos Power <dev@bravospower.com>
 License-Expression: MIT
-Project-URL: Homepage, https://bravos-power.github.io/pyoframe/
-Project-URL: documentation, https://bravos-power.github.io/pyoframe/
+Project-URL: Homepage, https://bravos-power.github.io/pyoframe/latest
+Project-URL: documentation, https://bravos-power.github.io/pyoframe/latest
 Project-URL: repository, https://github.com/Bravos-Power/pyoframe/
 Project-URL: Issues, https://github.com/Bravos-Power/pyoframe/issues
 Classifier: Programming Language :: Python :: 3
@@ -16,28 +16,27 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: polars~=1.0
-Requires-Dist: numpy
 Requires-Dist: pyarrow
-Requires-Dist: pandas
-Requires-Dist: pyoptinterface<1,>=0.4.1
+Requires-Dist: pandas<3
+Requires-Dist: pyoptinterface==0.5.1
 Provides-Extra: highs
-Requires-Dist: highsbox; extra == "highs"
+Requires-Dist: highsbox<=1.12.0; extra == "highs"
 Provides-Extra: ipopt
 Requires-Dist: pyoptinterface[nlp]; extra == "ipopt"
-Requires-Dist: llvmlite<=0.44.0; extra == "ipopt"
+Requires-Dist: llvmlite<=0.46.0; extra == "ipopt"
 Provides-Extra: dev
 Requires-Dist: ruff==0.12.11; extra == "dev"
 Requires-Dist: polars>=1.32.3; extra == "dev"
 Requires-Dist: pytest==8.4.1; extra == "dev"
 Requires-Dist: pytest-cov==6.2.1; extra == "dev"
-Requires-Dist: sybil[pytest]==9.2.0; extra == "dev"
+Requires-Dist: sybil[pytest]==9.3.0; extra == "dev"
 Requires-Dist: pre-commit==4.3.0; extra == "dev"
 Requires-Dist: gurobipy==12.0.3; extra == "dev"
 Requires-Dist: coverage==7.10.6; extra == "dev"
 Requires-Dist: ipykernel==6.30.1; extra == "dev"
-Requires-Dist: highsbox; extra == "dev"
+Requires-Dist: highsbox<=1.12.0; extra == "dev"
 Requires-Dist: pyoptinterface[nlp]; extra == "dev"
-Requires-Dist: llvmlite<=0.44.0; extra == "dev"
+Requires-Dist: numpy; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: mkdocs-material~=9.6.18; extra == "docs"
 Requires-Dist: mkdocstrings[python]~=0.30.0; extra == "docs"
@@ -57,7 +56,7 @@ Dynamic: license-file
 
 [![codecov](https://codecov.io/gh/Bravos-Power/pyoframe/graph/badge.svg?token=8258XESRYQ)](https://codecov.io/gh/Bravos-Power/pyoframe)
 [![Build](https://github.com/Bravos-Power/pyoframe/actions/workflows/ci.yml/badge.svg)](https://github.com/Bravos-Power/pyoframe/actions/workflows/ci.yml)
-[![Docs](https://github.com/Bravos-Power/pyoframe/actions/workflows/publish_doc.yml/badge.svg)](https://Bravos-Power.github.io/pyoframe/reference/)
+[![Docs](https://github.com/Bravos-Power/pyoframe/actions/workflows/publish_doc.yml/badge.svg)](https://Bravos-Power.github.io/pyoframe/latest/reference/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Issues Needing Triage](https://img.shields.io/github/issues-search/Bravos-Power/pyoframe?query=no%3Alabel%20is%3Aopen&label=Needs%20Triage)](https://github.com/Bravos-Power/pyoframe/issues?q=is%3Aopen+is%3Aissue+no%3Alabel)
 [![Open Bugs](https://img.shields.io/github/issues-search/Bravos-Power/pyoframe?query=label%3Abug%20is%3Aopen&label=Open%20Bugs)](https://github.com/Bravos-Power/pyoframe/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
@@ -65,9 +64,9 @@ Dynamic: license-file
 
 A library to rapidly and memory-efficiently formulate large and sparse optimization models using Pandas or Polars DataFrames.
 
-## **[Documentation](https://bravos-power.github.io/pyoframe/)**
+## **[Documentation](https://bravos-power.github.io/pyoframe/latest/)**
 
-[Read the documentation](https://bravos-power.github.io/pyoframe/) to get started or to learn how to [contribute](https://bravos-power.github.io/pyoframe/contribute/index.md).
+[Read the documentation](https://bravos-power.github.io/pyoframe/latest/) to get started or to learn how to [contribute](https://bravos-power.github.io/pyoframe/latest/contribute/index.md).
 
 
 ## Acknowledgments

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/README.md

@@ -2,7 +2,7 @@
 
 [![codecov](https://codecov.io/gh/Bravos-Power/pyoframe/graph/badge.svg?token=8258XESRYQ)](https://codecov.io/gh/Bravos-Power/pyoframe)
 [![Build](https://github.com/Bravos-Power/pyoframe/actions/workflows/ci.yml/badge.svg)](https://github.com/Bravos-Power/pyoframe/actions/workflows/ci.yml)
-[![Docs](https://github.com/Bravos-Power/pyoframe/actions/workflows/publish_doc.yml/badge.svg)](https://Bravos-Power.github.io/pyoframe/reference/)
+[![Docs](https://github.com/Bravos-Power/pyoframe/actions/workflows/publish_doc.yml/badge.svg)](https://Bravos-Power.github.io/pyoframe/latest/reference/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Issues Needing Triage](https://img.shields.io/github/issues-search/Bravos-Power/pyoframe?query=no%3Alabel%20is%3Aopen&label=Needs%20Triage)](https://github.com/Bravos-Power/pyoframe/issues?q=is%3Aopen+is%3Aissue+no%3Alabel)
 [![Open Bugs](https://img.shields.io/github/issues-search/Bravos-Power/pyoframe?query=label%3Abug%20is%3Aopen&label=Open%20Bugs)](https://github.com/Bravos-Power/pyoframe/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
@@ -10,9 +10,9 @@
 
 A library to rapidly and memory-efficiently formulate large and sparse optimization models using Pandas or Polars DataFrames.
 
-## **[Documentation](https://bravos-power.github.io/pyoframe/)**
+## **[Documentation](https://bravos-power.github.io/pyoframe/latest/)**
 
-[Read the documentation](https://bravos-power.github.io/pyoframe/) to get started or to learn how to [contribute](https://bravos-power.github.io/pyoframe/contribute/index.md).
+[Read the documentation](https://bravos-power.github.io/pyoframe/latest/) to get started or to learn how to [contribute](https://bravos-power.github.io/pyoframe/latest/contribute/index.md).
 
 
 ## Acknowledgments

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/docs/.nav.yml

@@ -8,6 +8,6 @@ nav:
     - learn/advanced-concepts
     - learn/migrate
   - examples
-  - reference
+  - Reference API: reference
   - why-pyoframe/index.md
   - contribute

pyoframe-1.1.0/docs/contribute/index.md

@@ -0,0 +1,65 @@
+---
+hide:
+  - navigation
+---
+# Contribute
+
+Contributions are more than welcome! Submit a pull request, or [open an issue](https://github.com/Bravos-Power/pyoframe/issues/new) and I (Martin) will gladly answer your questions on how to contribute.
+
+## Setup a development environment
+
+1. Clone this repository.
+```console
+git clone https://github.com/Bravos-Power/pyoframe
+```
+
+2. Install the dependencies. 
+```console
+pip install --editable .[dev,docs]
+```
+
+3. Install the pre-commit hooks. 
+```console
+pre-commit install
+```
+
+## Running the test suite
+
+Run `pytest` to execute the test suite. (If you'd like to view coverage information add the flag `--cov` and then run `coverage html`.)
+
+The only errors you should see when running the test suite are those related to a solver not being installed.
+
+Pyoframe has several types of tests.
+
+1. Your typical unit tests under the `tests/` folder.
+
+2. Integration tests in `tests/test_examples.py`. These tests will run all the models in `tests/examples` and make sure that your changes haven't altered the model results (stored under `tests/examples/<model>/results`). In the rare cases where you _want_ the model results to change (e.g. if you've changed the model), you can regenerate the results using `python -m tests.test_examples`.
+
+3. Doctests in the docstrings of the source code (`src/`).
+
+4. Documentation tests (in `docs/`). All Python code blocks in the documentation are run to ensure the documentation doesn't become outdated. This is done using Sybil. Refer to the [Sybil documentation](https://sybil.readthedocs.io/en/latest/markdown.html#code-blocks) to learn how to create setup code or skip code blocks you don't wish to test.
+
+!!! warning "Non-breaking spaces"
+    Be aware that Pyoframe uses non-breaking spaces to improve the formatting of expressions. If your Sybil tests are unexpectedly failing, make sure that the expected output contains all the needed non-breaking spaces.
+
+## Writing documentation
+
+You can preview the documentation website by running `mkdocs serve` and navigating to [`http://127.0.0.1:8000/pyoframe/`](http://127.0.0.1:8000/pyoframe/).
+
+We use [Material Docs](https://squidfunk.github.io/mkdocs-material/) for documentation with several plugins to enable features like automatically compiling the docstrings into the reference API. Please follow the [Google docstring style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) and the [Google style guide](https://developers.google.com/style). We use Mike to allow readers to view the documentation for previous releases (preview available via `mike serve`).
+
+## Linting and formatting
+
+We use Ruff for linting and formatting. The pre-commit hooks will run `ruff format` on commit. You should also make sure `ruff check` returns no errors before submitting a PR. To format code blocks in the documentation run: `doccmd --language=python --no-pad-file --command="ruff format" docs/`.
+
+## Additional tips
+
+I recommend skimming or reading the [Internal Details](../learn/advanced-concepts/internals.md) page for some background on how Pyoframe works.
+
+For core developers:
+
+- If you use `.unique`, `.join`, `.sort`, or `.group_by` on a Polars dataframe, make sure to set the `maintain_order` parameter appropriately (typically, `maintain_order=Config.maintain_order`).
+
+For repository maintainers:
+
+- Our CI pipeline on Github Actions requires a Gurobi and COPT license to run. If the Gurobi license expires, generate a new one and copy the contents of the `guorbi.lic` file into the `GUROBI_WLS` Github secret (Settings -> Secrets and variables -> actions). Similarly, if the COPT license expires, request a new academic license (or email COPT sales for a free one) and copy the contents of both license files to the matching Github secrets.

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/docs/examples/diet.md

@@ -28,9 +28,9 @@ m.Buy = pf.Variable(food["food"], lb=0, ub=food[["food", "stock"]])
 
 nutrient_intake = (m.Buy * food_nutrients).sum_by("category")
 m.min_nutrients = (
-    nutrients[["category", "min"]] <= nutrient_intake.drop_unmatched()  # (1)!
+    nutrients[["category", "min"]] <= nutrient_intake.drop_extras()  # (1)!
 )
-m.max_nutrients = nutrient_intake.drop_unmatched() <= nutrients[["category", "max"]]
+m.max_nutrients = nutrient_intake.drop_extras() <= nutrients[["category", "max"]]
 
 total_cost = (m.Buy * food[["food", "cost"]]).sum()
 m.minimize = total_cost
@@ -39,7 +39,7 @@ m.minimize = total_cost
 m.optimize()
 ```
 
-1. `.drop_unmatched()` ensures that if `min_nutrient` is `null` for certain foods, no constraint will be created for those foods. [Learn more](../learn/concepts/special-functions.md#drop_unmatched-and-keep_unmatched)
+1. `.drop_extras()` ensures that if `min_nutrient` is `null` for certain foods, no constraint will be created for those foods. [Learn more](../learn/concepts/addition.md)
 
 So the solution is...
 

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/docs/examples/facility_location.md

@@ -26,12 +26,12 @@ model.customers = model.x_axis * model.y_axis  # (1)!
 
 
 model.facility_position = pf.Variable(model.facilities, model.axis, lb=0, ub=1)
-model.customer_position_x = pd.DataFrame(
+model.customer_position_x = pf.Param(
     {"x": range(G), "x_pos": [step / (G - 1) for step in range(G)]}
-).to_expr()
-model.customer_position_y = pd.DataFrame(
+)
+model.customer_position_y = pf.Param(
     {"y": range(G), "y_pos": [step / (G - 1) for step in range(G)]}
-).to_expr()
+)
 
 model.max_distance = pf.Variable(lb=0)
 

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/docs/index.md

@@ -12,7 +12,7 @@ hide:
 - Seamlessly integrates with pandas thanks to its dataframe-centric design.
 - Extremely **fast and memory efficient** (even for sparse problems) thanks to Polars, Rust, and Pyoptinterface.
 - Clear Pythonic syntax for writing mathematical models.
-- Supports Gurobi, HiGHS, and Ipopt solvers.
+- Supports Gurobi, HiGHS, Ipopt and COPT solvers.
 - Continuously used in high-stakes production environments.
 - 100% open-source (MIT License).
 

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/docs/learn/advanced-concepts/internals.md

@@ -1,7 +1,6 @@
 # Internal details
 
-Pyoframe's inner workings involve a few tricks that you should be aware of
-if you wish to modify Pyoframe's internal code.
+Pyoframe's inner workings involve a few tricks that you should be aware of if you wish to contribute to Pyoframe's code base.
 
 ## The zero variable
 
@@ -16,4 +15,10 @@ constant terms and also simplifies the [handling of quadratics](#quadratics).
 
 Internally, [Expression][pyoframe.Expression] is used to represent both linear and quadratic mathematical expressions. When a quadratic expression is formed, column `__quadratic_variable_id` is added to [Expression.data][pyoframe.Expression.data]. If an expression's quadratic terms happen to cancel out (e.g. `(ab + c) - ab`), this column is automatically removed.
 
-Column `__quadratic_variable_id` records the ID of the _second_ variable in a quadratic term (the `b` in `3ab`). For linear terms, which have no second variable, this column contains the [Zero Variable](#the-zero-variable). Quadratic terms are always stored such that the first term's variable ID (in column `__variable_id`) is greater or equal to the second term's variable id (in column `__quadratic_variable_id`). For example, `var_7 * var_8` would be rearranged and stored as `var_8 * var_7`. This helps simplify expressions and provides a useful guarantee: If the variable in the first column (`__variable_id`) is the Zero Variable (`var_0`) we know the variable in the second column must also be the Zero Variable and, thus, the term must be a constant.
+Column `__quadratic_variable_id` records the ID of the _second_ variable in a quadratic term (the `b` in `3ab`). For linear terms, which have no second variable, this column contains the [Zero Variable](#the-zero-variable).
+
+Quadratic terms are always stored such that the first term's variable ID (in column `__variable_id`) is greater or equal to the second term's variable id (in column `__quadratic_variable_id`). For example, `var_7 * var_8` would be rearranged and stored as `var_8 * var_7`. This helps simplify expressions and provides a useful guarantee: If the variable in the first column (`__variable_id`) is the Zero Variable (`var_0`) we know the variable in the second column must also be the Zero Variable and, thus, the term must be a constant.
+
+## Division
+
+Divisions are rearranged into multiplications when possible. Specifically, `a / b` is computed as `a * (1 / b)` (see `BaseOperableBlock.__truediv__`) except for the special case where `a` is a `float` or `int`. In that case, a Polars operation is used to compute the division (see `Expression.__rtruediv__`).

{pyoframe-1.0.0a0 → pyoframe-1.1.0}/docs/learn/advanced-concepts/performance.md

@@ -6,9 +6,9 @@ Pyoframe is already one of the fastest and most memory-efficient libraries for f
 
 [Polars](https://pola.rs/) is much faster than Pandas. Moreover, if you use Pandas, there will be a (very small) overhead because Pyoframe converts all DataFrames to Polars prior to computations.
 
-## Use integer indices
+## Use integer labels
 
-Pyoframe will work with all types of indices, however integer indices are faster and more memory efficient than alternatives (e.g. string indices).
+Pyoframe works with any label data type (e.g. string labels, date labels, etc.), but integer labels are fastest and most memory efficient.
 
 ## Disable `maintain_order`
 
@@ -18,14 +18,14 @@ By default, Pyoframe ensures that the order of variables, constraints, and mathe
 pf.Config.maintain_order = False
 ```
 
-## Disable unmatched checks
+## Disable checks for extra values
 
-Disabling unmatched checks means that, instead of raising [unmatched term exceptions](../concepts/special-functions.md#drop_unmatched-and-keep_unmatched), pyoframe will process sums with unmatched terms as if [`keep_unmatched`][pyoframe.Expression.keep_unmatched] had been applied. While this may improve performance, it will silence potentially important errors meant to help you build your model. If you'd like to disable unmatched checks, we recommend you do so only after thoroughly testing your model and ensuring that all potential unmatched term exceptions have been handled.
+Disabling checks for extra values means that, instead of raising [extra value exceptions](../concepts/addition.md), pyoframe will process sums with extra values as if [`keep_extras`][pyoframe.Expression.keep_extras] had been applied. While this may improve performance, it will silence potentially important errors meant to help you build your model. If you'd like to disable checks for extra values, we recommend you do so only after thoroughly testing your model and ensuring that all potential extra value exceptions have been handled.
 
-The following code disables unmatched checks:
+The following code disables checks for extra values:
 
 ```python
-pf.Config.disable_unmatched_checks = True
+pf.Config.disable_extras_checks = True
 ```
 
 <!-- TODO REVISIT

pyoframe-1.1.0/docs/learn/concepts/.nav.yml

@@ -0,0 +1,4 @@
+nav:
+  - addition.md
+  - special-functions.md
+  - solver-access.md