This directory contains the necessary files to automatically generate the notebooks table in the main README.md file.
- The
notebooks-table-data.csvfile contains the data for all notebooks. - The
autogenerate_notebooks_table.pyscript reads this CSV file and updates the main README.md file with a generated table. - The README.md file contains special marker comments to designate where the table should be inserted.
Follow these steps to add a new notebook:
-
Add your new
.ipynbnotebook file to thenotebooksdirectory. -
Add a new entry to the
notebooks-table-data.csvfile with the following information:title: The display title for your notebooknotebook_filename: The filename of your notebookcolab_link: The link to your notebook in Colabresources: Markdown-formatted links to datasets, models, etc.paper_link: Link to the relevant research paperpaper_title: Title of the research paperrepo_link: Link to the relevant GitHub repositoryrepo_name: Name of the repository
-
Run the automation script:
python3 automation/autogenerate_notebooks_table.py
-
The main README.md file will be updated automatically with your new notebook entry.
-
Commit and push your changes:
git add notebooks/your_new_notebook.ipynb git add automation/notebooks-table-data.csv git add README.md git commit -m "Add new notebook: Your Notebook Title" git push
- The script looks for markers
<!-- NOTEBOOKS_TABLE_START -->and<!-- NOTEBOOKS_TABLE_END -->in the README.md file to know where to insert the table. - If the markers don't exist, the script will try to add them after the "## Notebooks" heading.
- Make sure to follow the CSV format exactly to ensure the table is generated correctly.
...table content...