Skip to content

Commit

Permalink
title and position of colab
Browse files Browse the repository at this point in the history
  • Loading branch information
sgbaird committed Mar 1, 2025
1 parent 78c4a71 commit d9ca819
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions docs/curriculum/api-usage/honegumi-api-getting-started.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,17 @@
{
"cell_type": "markdown",
"metadata": {
"colab_type": "text",
"id": "view-in-github"
"id": "DYoVMfsLfE57"
},
"source": [
"<a href=\"https://colab.research.google.com/github/sgbaird/honegumi/blob/main/docs/curriculum/api-usage/honegumi-api-getting-started.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
"# Getting Started with the Honegumi API"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "DYoVMfsLfE57"
},
"metadata": {},
"source": [
"# Honegumi API Tutorial"
"<a href=\"https://colab.research.google.com/github/sgbaird/honegumi/blob/main/docs/curriculum/api-usage/honegumi-api-getting-started.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
]
},
{
Expand All @@ -25,9 +22,9 @@
"id": "_yjJI_s-fYPy"
},
"source": [
"The interactive selection grid hosted at https://honegumi.readthedocs.io/ provides a lot of value on its own. This tutorial demonstrates how to use the `honegumi` Python package to generate Bayesian optimization scripts on-the-fly, which has a lot of potential to be integrated with LLMs and agentic workflows. We recommend you open and run this using the `Open in Colab` link above.\n",
"The interactive selection grid hosted on the main page at https://honegumi.readthedocs.io/ provides a lot of value on its own. This tutorial demonstrates how to use the `honegumi` Python package to generate Bayesian optimization scripts on-the-fly, which has a lot of potential to be integrated with LLMs and agentic workflows. We recommend you open and run this using the `Open in Colab` link above.\n",
"\n",
"NOTE: We encourage you to also look at a few of the [materials-focused tutorials](https://honegumi.readthedocs.io/en/latest/tutorials.html) and [concept-focused docs](https://honegumi.readthedocs.io/en/latest/concepts.html)."
"NOTE: We also encourage you to look at the [materials discovery tutorials](../../tutorials.md) and [concept-focused docs](../../concepts.md)."
]
},
{
Expand Down Expand Up @@ -1460,7 +1457,7 @@
"id": "BPt3DEy-me3K"
},
"source": [
"Perhaps the most important file is [`main.py.jinja`](https://github.com/sgbaird/honegumi/blob/main/src/honegumi/ax/main.py.jinja), which encodes all of the logic for generating the scripts. The file is printed below. For more information about the templating language, see our Colab tutorial: [A Gentle Introduction to Jinja2](https://colab.research.google.com/github/sgbaird/honegumi/blob/main/notebooks/1.0-sgb-gentle-introduction-jinja.ipynb)."
"Perhaps the most important file is [main.py.jinja](https://github.com/sgbaird/honegumi/blob/main/src/honegumi/ax/main.py.jinja), which encodes all of the logic for generating the scripts. The file is printed below. For more information about the templating language, see our Colab tutorial: [A Gentle Introduction to Jinja2](https://colab.research.google.com/github/sgbaird/honegumi/blob/main/notebooks/1.0-sgb-gentle-introduction-jinja.ipynb)."
]
},
{
Expand Down Expand Up @@ -1894,10 +1891,10 @@
"source": [
"Here are some other important files related to the Honegumi framework (applicable if you want to improve Honegumi or use it to create dynamic grid selections for other applications):\n",
"\n",
"- [`honegumi/ax/main.py.jinja`](https://github.com/sgbaird/honegumi/blob/main/src/honegumi/ax/main.py.jinja) which is the template that's supplied to the `Honegumi` class.\n",
"- [`honegumi/core/honegumi.html.jinja`](https://github.com/sgbaird/honegumi/blob/main/src/honegumi/core/honegumi.html.jinja) which updates [`docs/honegumi.html`](https://github.com/sgbaird/honegumi/blob/main/docs/honegumi.html) via [`scripts/generate_scripts.py`](https://github.com/sgbaird/honegumi/blob/main/scripts/generate_scripts.py)\n",
"- [honegumi/ax/main.py.jinja](https://github.com/sgbaird/honegumi/blob/main/src/honegumi/ax/main.py.jinja) which is the template that's supplied to the `Honegumi` class.\n",
"- [honegumi/core/honegumi.html.jinja](https://github.com/sgbaird/honegumi/blob/main/src/honegumi/core/honegumi.html.jinja) which updates [docs/honegumi.html](https://github.com/sgbaird/honegumi/blob/main/docs/honegumi.html) via [scripts/generate_scripts.py](https://github.com/sgbaird/honegumi/blob/main/scripts/generate_scripts.py)\n",
"\n",
"[`docs/honegumi.html`](https://github.com/sgbaird/honegumi/blob/main/docs/honegumi.html) also uses [PyScript](https://pyscript.com/) in conjunction with [`docs/main.py`](https://github.com/sgbaird/honegumi/blob/main/docs/main.py) and [`docs/pyscript.toml`](https://github.com/sgbaird/honegumi/blob/main/docs/pyscript.toml) to update the interactive grid on the website on-the-fly without pregenerating all possible combinations (this is the secret to the scalability of the Honegumi framework to many options).\n",
"[docs/honegumi.html](https://github.com/sgbaird/honegumi/blob/main/docs/honegumi.html) also uses [PyScript](https://pyscript.com/) in conjunction with [docs/main.py](https://github.com/sgbaird/honegumi/blob/main/docs/main.py) and [docs/pyscript.toml](https://github.com/sgbaird/honegumi/blob/main/docs/pyscript.toml) to update the interactive grid on the website on-the-fly without pregenerating all possible combinations (this is the secret to the scalability of the Honegumi framework to many options).\n",
"\n",
"---\n",
"\n",
Expand Down

0 comments on commit d9ca819

Please sign in to comment.