Skip to content

Commit f3cc56e

Browse files
committed
add how to run in index
1 parent 9e4878f commit f3cc56e

4 files changed

Lines changed: 51 additions & 5 deletions

File tree

chapter_2/llms_for_biology.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"\n",
1414
"As the volume of scientific literature continues to grow rapidly, manually extracting and organizing this information becomes increasingly difficult and time-consuming. Therefore, automating data extraction from the literature using AI can help researchers to rapidly identify relevant findings, convert unstructured text into structured datasets, and integrate knowledge across thousands of publications. \n",
1515
"\n",
16-
"::{admonition} 🚀 Getting Started\n",
16+
":::{admonition} 🚀 Getting Started\n",
1717
":class: tip\n",
1818
"\n",
1919
"This tutorial can be launched using the rocket button at the top of the page.\n",

chapter_3/agent_mcp_example.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"\n",
99
"In chapters 3.2 and 3.3 we learned how to write boilerplate code and implement agents. But the problem is, if you are not a python programmer you might find this to be tedious. This may not be the main problem you want to solve and might be interested in a simpler solution.\n",
1010
"\n",
11-
"::{admonition} 🚀 Getting Started\n",
11+
":::{admonition} 🚀 Getting Started\n",
1212
":class: tip\n",
1313
"\n",
1414
"This tutorial can be launched using the rocket button at the top of the page.\n",

chapter_3/aviary_agent_implementation.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"Figure 3.2.1: An agent iteratively received observations from the environment, takes an action based on the observation until the task is completed.\n",
2121
"```\n",
2222
"\n",
23-
"::{admonition} 🚀 Getting Started\n",
23+
":::{admonition} 🚀 Getting Started\n",
2424
":class: tip\n",
2525
"\n",
2626
"This tutorial can be launched using the rocket button at the top of the page.\n",

index.md

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,52 @@ By the end of this series, you should:
2323

2424
- A curious mindset
2525

26-
# Contact Us for Questions, Suggestions and Feedback
26+
# Using Tutorials
2727

28-
Email us at: tutorials@futurehouse.org
28+
The tutorials can be launched using the rocket (🚀) button at the top of the page.
29+
30+
### Option 1 — Google Colab (**recommended**)
31+
Opens the notebook in Google Colab with the fastest and most reliable experience.
32+
33+
Before running the tutorial, add your API keys using **either**:
34+
35+
- a `.env` file, or
36+
- **Colab Secrets** (`🔑 Secrets` tab in the left sidebar)
37+
38+
Example `.env`:
39+
```bash
40+
OPENAI_API_KEY=your_key_here
41+
ANTHROPIC_API_KEY=your_key_here
42+
```
43+
44+
### Option 2 — MyBinder
45+
Launches a temporary cloud Jupyter environment directly in your browser.
46+
47+
⚠️ Binder environments can take a few minutes to build and start.
48+
49+
After the notebook loads, create a `.env` file in the notebook directory containing your API keys:
50+
51+
```bash
52+
OPENAI_API_KEY=your_key_here
53+
ANTHROPIC_API_KEY=your_key_here
54+
```
55+
56+
### Notes
57+
- You only need API keys for the providers used in a given notebook.
58+
- Never commit or publicly share your API keys.
59+
- If a cell fails due to missing credentials, verify that your keys were loaded correctly before rerunning the cell.
60+
61+
62+
# Contacting Us
63+
64+
We’d love to hear from you! Whether you run into issues, have ideas for improving the tutorials, or want to suggest new topics, feel free to reach out.
65+
66+
Email us at: [tutorials@futurehouse.org](tutorials@futurehouse.org)
67+
68+
When reporting an issue, it’s helpful to include:
69+
70+
- The tutorial chapter number and/or title
71+
- Whether you used Google Colab or Binder
72+
- The full error message or screenshot (if available)
73+
74+
We’re actively improving these tutorials and appreciate your feedback and contributions.

0 commit comments

Comments
 (0)