Handle latex equations in markdown #297
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
|
It's possible that the added function does not fix the rendering issues. From the image below, it seems that Latex is not supported on docs generated by readme.com. So I used images instead. |
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
AzulGarza
requested changes
Apr 24, 2024
There was a problem hiding this comment.
thank you so much @marcopeix! great work. i've published the new docs from this branch:
it would be great if we could:
- remove the
equationtext behind each equation. - fix the problem with the lists.
- fix the space between the paragraph and the next section so the
####header can be rendered properly.
ideally, these changes will help also render correctly other sections of the documentation, for example, in the calendar features tutorial:
I'll share on slack how you can deploy the docs to readme from a branch.
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
Experiment ResultsExperiment 1: air-passengersDescription:
Results:
Plot:
Experiment 2: air-passengersDescription:
Results:
Plot:
Experiment 3: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 4: electricity-multiple-seriesDescription:
Results:
Plot:
Experiment 5: electricity-multiple-seriesDescription:
Results:
Plot:
|
|
@mergenthaler @AzulGarza , I don't know if this PR is still useful, but I use .png files to render the equations using codecogs. This way, the background is always white and the equations are readable in both light and dark mode. If it's not necessary, ignore this PR! Result looks like this: |
|
@marcopeix, can we close this? Or is this still unresolved? If yes, please link to the corresponding PR and close this. |
|
Not required since this PR was merged. Closing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Modifying the markdown now handles Latex equations.
The behavior is similar to how codeblocks are handled:
Here is an example of an equation after the modify_markdown function is done:
$\mathrm{MAE}(\mathbf{y}{\tau}, \mathbf{\hat{y}}{\tau}) = \frac{1}{H} \sum^{t+H}{\tau=t+1} |y{\tau} - \hat{y}_{\tau}|$
In the notebook containing these equations, I used small headers instead of bold text for better rendering on the docs.