Skip to content

Commit 6ffaf12

Browse files
committed
Correct admonition syntax
1 parent a491da2 commit 6ffaf12

File tree

2 files changed

+22
-8
lines changed

2 files changed

+22
-8
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,9 @@ Install with dependencies from the root directory of the cloned repo:
6060
pip install -e .
6161
```
6262

63-
[!NOTE]
64-
To avoid potential dependency conflicts, please install ESGPT first before installing ACES. This ensures compatibility with the `polars` version required by ACES.
63+
> [!NOTE]
64+
> To avoid potential dependency conflicts, please install ESGPT first before installing ACES. This ensures
65+
> compatibility with the `polars` version required by ACES.
6566
6667
## Instructions for Use
6768

@@ -230,8 +231,12 @@ Fields for a "plain" predicate:
230231
- `value_max_inclusive` (optional): Must be a boolean specifying whether `value_max` is inclusive or not.
231232
- `other_cols` (optional): Must be a 1-to-1 dictionary of column name and column value, which places additional constraints on further columns.
232233

233-
[!NOTE]
234-
For memory optimization, we strongly recommend using either the List of Values or Regular Expression formats whenever possible, especially when needing to match multiple values. Defining each code as an individual string will increase memory usage significantly, as each code generates a separate predicate column. Using a list or regex consolidates multiple matching codes under a single column, reducing the overall memory footprint.
234+
> [!NOTE]
235+
> For memory optimization, we strongly recommend using either the List of Values or Regular Expression formats
236+
> whenever possible, especially when needing to match multiple values. Defining each code as an individual
237+
> string will increase memory usage significantly, as each code generates a separate predicate column. Using a
238+
> list or regex consolidates multiple matching codes under a single column, reducing the overall memory
239+
> footprint.
235240

236241
#### Derived Predicates
237242

docs/source/usage.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,16 @@ windows:
6161
label: death
6262
```
6363
64-
[!NOTE]
65-
Each configuration file contains [`predicates`](https://eventstreamaces.readthedocs.io/en/latest/readme.html#predicates), a [`trigger`](https://eventstreamaces.readthedocs.io/en/latest/readme.html#trigger-event), and [`windows`](https://eventstreamaces.readthedocs.io/en/latest/readme.html#windows). Additionally, the `label` field is used to extract the predicate count from the window it was defined in, which acts as the task label. This has been set to the `death` predicate from the `target` window in this example. The `index_timestamp` is used to specify the timestamp at which a prediction is made and can be set to `start` or `end` of a particular window. In most tasks, including this one, it can be set to `end` in the window containing input data (`input` in this example).
64+
> [!NOTE]
65+
> Each configuration file contains
66+
> [`predicates`](https://eventstreamaces.readthedocs.io/en/latest/readme.html#predicates), a
67+
> [`trigger`](https://eventstreamaces.readthedocs.io/en/latest/readme.html#trigger-event), and
68+
> [`windows`](https://eventstreamaces.readthedocs.io/en/latest/readme.html#windows). Additionally, the `label`
69+
> field is used to extract the predicate count from the window it was defined in, which acts as the task
70+
> label. This has been set to the `death` predicate from the `target` window in this example. The
71+
> `index_timestamp` is used to specify the timestamp at which a prediction is made and can be set to `start`
72+
> or `end` of a particular window. In most tasks, including this one, it can be set to `end` in the window
73+
> containing input data (`input` in this example).
6674

6775
### Run the CLI
6876

@@ -231,8 +239,9 @@ Shell completion can be enabled for the Hydra configuration fields. For Bash, pl
231239
eval "$(aces-cli -sc install=bash)"
232240
```
233241

234-
[!NOTE]
235-
you may have to run this command for every terminal - please visit [Hydra's Documentation](https://hydra.cc/docs/tutorials/basic/running_your_app/tab_completion/) for more details.
242+
> [!NOTE]
243+
> you may have to run this command for every terminal - please visit [Hydra's
244+
> Documentation](https://hydra.cc/docs/tutorials/basic/running_your_app/tab_completion/) for more details.
236245

237246
### MEDS
238247

0 commit comments

Comments
 (0)