Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Changes #57

Merged
merged 14 commits into from
Jun 13, 2024
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,12 +300,25 @@ The `has` field specifies constraints relating to predicates within the window.

Support for static data depends on your data standard and those variables are expressed. For instance, in MEDS, it is feasible to express static data as a predicate, and thus criteria can be set normally. However, this is not yet incorporated for ESGPT. If a predicates dataframe is directly used, you may create a predicate column that specifies your static variable.

### Complementary Tools

% Using ACES in Concert with Other tools

ACES is a component of the MEDS ecosystem; to learn more about other tools with which you can use ACES, please see the following:
\\begin\{itemize}
\\item To extract data in the MEDS format, LINK
\\item To produce automated tabular (XGBoost) baseline methods over ACES defined task dataframes for MEDS datasets, see LINK
\\item ...
\\end\{itemize}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding actual links where 'LINK' is mentioned to provide complete information.

### Alternative Tools

TODO

## Future Roadmap

TODO add more commentary
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please provide more details or remove the placeholder if it's not intended to be filled immediately.


### Usability

- Extract indexing information for easier setup of downstream tasks ([#37](https://github.com/justin13601/ACES/issues/37))
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ def ensure_pandoc_installed(_):


# -- Options for LaTeX output

# latex_engine = "xelatex"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider removing the commented-out preamble settings if they are no longer needed to clean up the configuration file.

-    "preamble": "\n".join(
-        [
-            r"\usepackage{svg}",
-            ...
-            r"\DeclareUnicodeCharacter{2559}{+}",
-        ]
-    ),

Committable suggestion was skipped due to low confidence.

latex_elements = { # type: ignore
# The paper size ("letterpaper" or "a4paper").
"papersize": "letterpaper",
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Sample Data Tutorial <notebooks/tutorial>
Predicates DataFrame <notebooks/predicates>
Configuration Language <configuration>
Algorithm & Terminology <terminology>
Profiling <profiling>
Computational Profiling <profiling>
Module API Reference <api/modules>
License <license>
```
Expand Down
2 changes: 0 additions & 2 deletions docs/source/license.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,3 @@
language: text
---
```

______________________________________________________________________
4 changes: 3 additions & 1 deletion docs/source/profiling.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# TODO - include the table from supplementary
# Computational Profile

TODO - include the table from supplementary
Loading