Skip to content

Commit

Permalink
docs: add ignored_rules note
Browse files Browse the repository at this point in the history
Signed-off-by: develop-cs <[email protected]>
  • Loading branch information
develop-cs committed Jul 29, 2024
1 parent 86fcd7c commit b9d6187
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/pages/how_to.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,19 @@ conditions:
value: true
```

!!! info "Ignoring rules during execution"

You can **ignore** (i.e., disable) some rules if needed. Just give the **ids** of the rules that you want the *rules engine* to ignore when calling the `apply_rules()` method.

Use its `ignored_rules` parameter:

```python
ignored_rules = {"ADMITTED_RULE", "RULE_XYZ"}
res = eng.apply_rules(input_data, ignored_rules=ignored_rules)
```

Cf. [API reference](https://maif.github.io/arta/api_reference/#arta._engine.RulesEngine.apply_rules).

### Condition and Action

**Conditions** and **actions** are quite similar in terms of implementation but their goals are different.
Expand Down

0 comments on commit b9d6187

Please sign in to comment.