documentation updates #24
Merged
Conversation
This file contains hidden or 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
- Simplified mkdocs.yml configuration and navigation - Updated README.md with better project documentation - Streamlined docs/index.md for clearer project overview - Updated docs/preprocess.md with current preprocessing criteria - Added .gitignore entries for Quarto report files
| *.ipynb filter=strip-notebook-output | ||
| # keep the output of the following notebooks when committing | ||
| SlurmGPU.ipynb !filter=strip-notebook-output | ||
| # *.ipynb filter=strip-notebook-output |
Collaborator
There was a problem hiding this comment.
We can keep the first line for this file and remove the rest (based on the most recent changes on feature/add-requested-vram
Collaborator
There was a problem hiding this comment.
Are these two just copies of the notebooks in the notebooks folder? Would it be better to copy them here and then expect the notebooks to be copied here after any changes to the notebooks or to just not include them here (or have a symlink or some other way to automate this process)?
| generic: true | ||
|
|
||
| extra_javascript: | ||
| # - javascripts/mathjax.js |
Collaborator
There was a problem hiding this comment.
Do we need to keep this comment?
| - Notebooks: | ||
| - Efficiency Analysis: 'notebooks/Efficiency Analysis.ipynb' | ||
| - Visualization: 'notebooks/Basic Visualization.ipynb' | ||
| # - Frequency Analysis: 'notebooks/Frequency Analysis.ipynb' |
Collaborator
There was a problem hiding this comment.
Should we keep this comment considering that frequency_analysis.md is in the Analysis section?
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.
No description provided.