Documentation #780
Documentation #780
Conversation
|
cc @jplotts I don't think this is finished. I'll delete the prompt file when it is. Notice how I handled the tutorial for creating model instances and model instance versions in I'm considering adding |
stevemessick
force-pushed
the
documentation
branch
from
90c52a8 to
cbe5cb6
Compare
|
Removed @jplotts Ready for review now. |
documentation/configuration.md
Outdated
There was a problem hiding this comment.
j/w - do these commands work? Last time I tried, they didn't seem to but maybe I did something wrong.
There was a problem hiding this comment.
They do work. But the -s option seems to be broken. It downloaded the entire leaderboard. For now, I'll remove the option.
documentation/kernels.md
Outdated
|
|
||
| **Arguments:** | ||
|
|
||
| * `<KERNEL>`: Kernel URL suffix (e.g., `kerneler/sqlite-global-default`). |
There was a problem hiding this comment.
nit - using a 9 year old kernel in a deprecated language doesn't feel like the best example. We should have some better examples, even if from the kerneler.
There was a problem hiding this comment.
Changed to kerneler/using-google-bird-vocalization-model.
There was a problem hiding this comment.
Why is the file called model_instance_variations if the commands are about model instance versions? I think the filename is wrong.
There was a problem hiding this comment.
I agree. Changed to model_instance_versions.md.
documentation/model_instances.md
Outdated
| @@ -0,0 +1,182 @@ | |||
| # Model Instances Commands | |||
|
|
|||
| Commands for interacting with instances of Kaggle Models. A model instance typically represents a specific framework or variation of a parent model. | |||
There was a problem hiding this comment.
j/w - are framework and variation synonyms? If so, maybe worth clarifying that (or just picking one and sticking with it).
There was a problem hiding this comment.
"Variation" is the new name for "instances". Deleted that here.
documentation/tutorials.md
Outdated
| Before starting these tutorials, please make sure you have: | ||
|
|
||
| 1. Installed the Kaggle CLI. | ||
| 2. Downloaded your `kaggle.json` API token from your Kaggle account page (e.g., `https://www.kaggle.com/YOUR_USERNAME/account`) and placed it in the `~/.kaggle/` directory (or `C:\Users\<Windows-username>\.kaggle\` on Windows). |
There was a problem hiding this comment.
https://www.kaggle.com/YOUR_USERNAME/account ... the username parameter is redirected out anyway. Probably best to simplify this to https://www.kaggle.com/settings so no one is confused.
documentation/tutorials.md
Outdated
| * Replace `"INSERT_TITLE_HERE"` with your desired dataset title, e.g., `"My Sample Dataset"`. | ||
| * Replace `"INSERT_SLUG_HERE"` with a URL-friendly version of your title, e.g., `"my-sample-dataset"`. |
There was a problem hiding this comment.
Might be worth mentioning that these are related.
There was a problem hiding this comment.
Added: The URL-friendly version is made by converting the title to lower-case and changing spaces to dashes.
documentation/tutorials.md
Outdated
| 1. **Create or identify a kernel on Kaggle.com.** | ||
| * Log in to kaggle.com. | ||
| * Create a new notebook (or use an existing one). For this tutorial, let's assume its title is "My CLI Test Kernel". | ||
| * Make a small change and **save a version** of the notebook on Kaggle.com (e.g., click "Save Version" and choose "Save & Run All (Commit)"). You cannot pull or push a kernel that is only in draft form. | ||
| * Note the kernel slug from the browser's address bar. It will be something like `YOUR_USERNAME/my-cli-test-kernel`. |
There was a problem hiding this comment.
I feel like this implies that the kernel can't be created from the CLI. I think this should be changed to init + push then pull, or we'll get comments asking about how to create from the command line.
There was a problem hiding this comment.
I'm not sure I agree. The tutorial is about updating an existing kernel. I'll re-word it to emphasize using an existing notebook, and only mention creating one if the user doesn't have any. We might want to add another tutorial about creating a kernel.
There was a problem hiding this comment.
And that didn't work. Not the tutorial, I meant using kaggle k init didn't work, at least not simply. It doesn't create the source, just the metadata file, but push requires both. Probably means we really need that tutorial.
Some of GEMINI.md was adapted from https://github.com/harperreed/dotfiles/blob/master/.claude/CLAUDE.md.