@@ -22,8 +22,8 @@ preferences within our organization.
2222Most of the cookbook content is Colab notebooks, which are stored as Json.
2323* Only the ` source ` of the ` cells ` should be analyzed/reviewed.
2424* Those cells can be either Markdown or python code (or sometimes bash in which case the code cell starts with ` %%bash ` ).
25- * The ` outputs ` do not have to be ignored, but if none of them changed, shile some code has, it might be a sign that the
26- notebook has note been run to check that it works, in which case a warning should be raised;
25+ * The ` outputs ` do not have to be ignored, but if none of them changed while some code has, it might be a sign that the
26+ notebook has not been run to check that it works, in which case a warning should be raised;
2727* If the ` execution_count ` has changed to something else than ` null ` , it usually indicates that the formatting script has not
2828 been run. A warning should be raised, but only once per notebook.
2929
@@ -33,6 +33,8 @@ Most of the cookbook content is Colab notebooks, which are stored as Json.
3333* Use one ` H1 ` header (` # ` in Markdown) for the title.
3434* Include the "open in colab" button immediately after the ` H1 ` . It should look like
3535 ` <a target=\"_blank\" href=\"URL\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" height=30/> `
36+ where ` URL ` should be ` https://colab.research.google.com/github/google-gemini/cookbook/blob/main/ ` followed by the notebook
37+ location in the cookbook
3638* Include an overview section before any code.
3739* use %pip instead of !pip
3840* Put the imports when they are first used.
0 commit comments