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

add autoML notebook with examples #198

Merged
merged 2 commits into from
Oct 9, 2024
Merged

add autoML notebook with examples #198

merged 2 commits into from
Oct 9, 2024

Conversation

marouabahri
Copy link
Collaborator

No description provided.

@tachyonicClock
Copy link
Collaborator

This is looking good in terms of the examples but there are some issues with how it will render on the website. The code that renders the website understands a slightly different version of markdown which can create some rendering issues (See https://nbsphinx.readthedocs.io/en/0.9.5/markdown-cells.html).


These are not your fault, but something we have to workaround for now. Specifically you will need to add a newline before bullet point lists.

For example, use:

Blah blah blah

* Blah blah

instead of:

Blah blah blah
* Blah blah

image


Another workaround is that the website needs header levels to only increment by one level at a time. Otherwise it misunderstands them:
image
This issue occurs when you skip header levels in the markdown. For example, this snippet creates issues:

# Header 1

### Header 3

This snippet does not:

# Header 1

## Header 2

### Header 3

#### Header 4

## Another Header 2

### Another Header 3

Another concern is that certain lines are especially long and could benefit from being split over multiple lines. At the moment these lines require the reader to scroll horizontally.

image


You can build the website by following the instructions on https://capymoa.org/contributing/docs.html#building-documentation

@tachyonicClock tachyonicClock merged commit ac7e578 into main Oct 9, 2024
2 of 3 checks passed
@tachyonicClock tachyonicClock deleted the automl_notebook branch November 13, 2024 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants