Skip to content

Create modelrepotest.mdx#696

Open
lavanya-gunreddi wants to merge 6 commits into
mainfrom
lg-modelrepotest
Open

Create modelrepotest.mdx#696
lavanya-gunreddi wants to merge 6 commits into
mainfrom
lg-modelrepotest

Conversation

@lavanya-gunreddi

Copy link
Copy Markdown
Contributor

No description provided.

@mintlify

mintlify Bot commented Jul 7, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
runpod-docs 🟢 Ready View Preview Jul 7, 2026, 12:44 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@lavanya-gunreddi

Copy link
Copy Markdown
Contributor Author

@Promptless add this as step one in the doc: Install Go (and the command is: brew install go)

@promptless

promptless Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Done — added Install Go (brew install go) as the new Step 1 and renumbered the remaining steps (Build runpodctl is now Step 2, and so on). The change is committed to this PR branch, so it should appear in the updated preview shortly.

Comment thread serverless/modelrepotest.mdx Outdated
export RUNPOD_GRAPHQL_URL="https://api.runpod.io/graphql"
export RUNPOD_API_KEY="your-api-key" # replace with your actual API key

export MODEL_NAME="$(whoami)-test-$(date +%s)" # unique name per test run — reusing the same name uploads a new version, not a new model

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can probably be changed to:

export MODEL_NAME="model_name"  # unique name per test run — reusing the same name uploads a new version, not a new model

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread serverless/modelrepotest.mdx Outdated

---

## Scripted testing

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should just remove this section, as it was just for internal testing

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread serverless/modelrepotest.mdx Outdated

```bash
runpodctl model add \
--name "$MODEL_NAME" \ # the name to register the model under in your repo

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There can't be comments after the \. The \ needs to be the last character on the line. The comments can go before or after.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread serverless/modelrepotest.mdx Outdated
```bash
export USER_ID="$(runpodctl user | jq -r '.id')" # your Runpod user ID
export MODEL_HASH="$(runpodctl model list --name "$MODEL_NAME" | jq -r '.[0].versions[0].hash')" # the hash from step 3
export MODEL_URL="https://local/${USER_ID}/${MODEL_NAME}:${MODEL_HASH}" # the full model reference URL

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's get rid of this line, as we will build the Model URL and also the reference below

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread serverless/modelrepotest.mdx Outdated
export MODEL_URL="https://local/${USER_ID}/${MODEL_NAME}:${MODEL_HASH}" # the full model reference URL
```

The resulting `MODEL_URL` will look like:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Get rid of this too, as we are no longer using this variable

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread serverless/modelrepotest.mdx Outdated

```bash
runpodctl serverless create \
--name "$(whoami)_ctl_test" \ # name for the endpoint

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be something more generic. whoami was confusing some users. It could be changed to:

  --name "my_worker" \ 

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread serverless/modelrepotest.mdx Outdated
--gpu-id "AMPERE_24" \ # GPU type
--workers-max 3 \ # maximum number of active workers
--workers-min 1 \ # minimum number of workers kept warm
--model-reference "$MODEL_URL" # attaches your model to the endpoint

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's change this line to these two lines:

  --model-reference "https://local/$USER_ID/$MODEL_NAME:$MODEL_HASH" \
  --env MODEL_NAME="/runpod/model-store/modelrepo-local/models/$USER_ID/$MODEL_NAME/$MODEL_HASH"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also need to add the following to work around a bug in runpodctl:

  --min-cuda-version "13.0"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread serverless/modelrepotest.mdx Outdated
```bash
runpodctl serverless create \
--name "$(whoami)_ctl_test" \ # name for the endpoint
--template-id "mockworker" \ # worker template to use

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's change this line to:

  --hub-id "cm8h09d9n000008jvh2rqdsmb" \

As that will actually do something if they use it, rather than being the mockworker which doesn't do anything

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

---

### Step 6: Verify the model is working

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also mention that they can use the Web UI to send requests to the worker, if they like

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@brosenpod

Copy link
Copy Markdown
Contributor

I added some comments in line, but generically, for all of the shell script code blocks, there can't be comments after the last \ on a line. The comments need to either go before or after the command. If they are copied as-is, they will fail.

@lavanya-gunreddi

Copy link
Copy Markdown
Contributor Author

@Promptless can you address all the pending comments from brosenpod ?

- Simplify MODEL_NAME example to a placeholder
- Remove internal-only scripted testing section
- Move inline comments off line-continuation (\) lines in shell blocks
- Drop unused MODEL_URL variable and its example
- Use generic --name, real --hub-id, and split model reference into
  --model-reference and --env, plus --min-cuda-version workaround
- Mention the web UI as an alternative for sending test requests
@promptless

promptless Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Done — I've addressed all of @brosenpod's pending review comments and pushed the changes to this PR branch. Summary of what changed in serverless/modelrepotest.mdx:

  1. MODEL_NAME export — updated to export MODEL_NAME="model_name" with the clarifying note that reusing a name uploads a new version, not a new model.
  2. Internal-only section — removed the section that was only for internal testing.
  3. Trailing comments after \ — audited every shell code block and moved inline comments off any line-continuation, so each \ is the last character on its line. Multi-line commands now carry their explanatory comments in a block above the command.
  4. Unused Model URL line — removed; the Model URL is now built inline below.
  5. Unused variable — removed the leftover variable line.
  6. whoami--name "my_worker" — replaced with a generic worker name to avoid confusion.
  7. --hub-id "cm8h09d9n000008jvh2rqdsmb" — swapped in for the mockworker so the flag actually does something.
  8. --model-reference split — now --model-reference "https://local/$USER_ID/$MODEL_NAME:$MODEL_HASH" plus --env MODEL_NAME=..., and added --min-cuda-version "13.0" to work around the runpodctl bug.
  9. Web UI — added a note that requests can also be sent to the worker from the web UI.

One additional cleanup: since --template-id was replaced with --hub-id, I updated the nearby note that referenced --template-id so it stays accurate.

The updated preview should refresh shortly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants