Skip to content

v1.2 added docs for catalog hidden_models #31

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
15 changes: 14 additions & 1 deletion sml-reference/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ label: SML Model Library
version: 1.0
aggressive_agg_promotion: false
build_speculative_aggs: false
hidden_models:
- Supply Model
- Sales Model
```

# Entitity Relationships
Expand All @@ -28,6 +31,7 @@ classDiagram
Boolean aggressive_agg_promotion
Boolean build_speculative_aggs
Object dataset_properties
Object hidden_models
}
```

Expand Down Expand Up @@ -64,6 +68,15 @@ not need to be unique.

The version of SML being used.

## hidden_models

- **Type:** array<string>
- **Required:** Y
- **Added in** v1.2
- **Use case:** When deploying a composite model the referenced component models may not need to be accessible as separate models.

A list of the models that will be excluded from the deploy. Cannot reference composite models, only regular models.

## aggressive_agg_promotion

- **Type:** boolean
Expand Down Expand Up @@ -114,7 +127,7 @@ Supported properties:
- `allow_peer_aggs`: Boolean, optional. Enables aggregation on data
derived from datasets in data warehouses that are different from the
source dataset.
- `allow_preferred_aggs`: Boolean, optional. Allow aggregates to be built
- `allow_preferred_aggs`: Boolean, optional. Allow aggregates to be built
in preferred storage.

Specify the `unique_name` of the dataset followed by the properties and
Expand Down
Loading