Skip to content

docs(discover): fix stale directory-scoped model tag examples #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
coketaste merged 1 commit into from
Jul 15, 2026
+10 −10
Merged

docs(discover): fix stale directory-scoped model tag examples #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,11 +406,11 @@ madengine discovers models from the MAD package using three methods:
# Root models (models.json)
madengine discover --tags pyt_huggingface_bert

# Directory-specific (scripts/{dir}/models.json)
madengine discover --tags dummy2:dummy_2
# Directory-specific (scripts/{dir}/models.json), scoped tag: {dir}/{model_or_tag}
madengine discover --tags dummy2/model1

# Dynamic with parameters (scripts/{dir}/get_models_json.py)
madengine discover --tags dummy3:dummy_3:batch_size=512
madengine discover --tags dummy3/model3:batch_size=512
```

## 📊 Performance Profiling
Expand Down
6 changes: 3 additions & 3 deletions docs/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ madengine discover --tags dummy,multi,vllm
# With verbose output
madengine discover --tags model --verbose

# Directory-specific models
madengine discover --tags dummy2:dummy_2
# Directory-specific models (scoped tag: {dir}/{model_or_tag})
madengine discover --tags dummy2/model1

# Dynamic models with parameters
madengine discover --tags dummy3:dummy_3:batch_size=512
madengine discover --tags dummy3/model3:batch_size=512
```

**Discovery Methods:**
Expand Down
8 changes: 4 additions & 4 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,18 +87,18 @@ madengine discover --tags dummy pyt_huggingface_bert

### 2. Directory-Specific Models

Models organized in subdirectories (`scripts/{dir}/models.json`):
Models organized in subdirectories (`scripts/{dir}/models.json`), selected with scoped tags (`{dir}/{model_or_tag}`):

```bash
madengine discover --tags dummy2:dummy_2
madengine discover --tags dummy2/model1
```

### 3. Dynamic Models with Parameters

Python-generated models (`scripts/{dir}/get_models_json.py`):
Python-generated models (`scripts/{dir}/get_models_json.py`), with extra args passed after `:`:

```bash
madengine discover --tags dummy3:dummy_3:batch_size=512:in=32
madengine discover --tags dummy3/model3:batch_size=512:in=32
```

## Build Workflow
Expand Down