diff --git a/website/docs/docs/build/about-metricflow.md b/website/docs/docs/build/about-metricflow.md index 4910f12a792..d76715c46a1 100644 --- a/website/docs/docs/build/about-metricflow.md +++ b/website/docs/docs/build/about-metricflow.md @@ -37,24 +37,6 @@ MetricFlow abides by these principles: - **Simplicity with gradual complexity:** Approach MetricFlow using familiar data modeling concepts. - **Performance and efficiency**: Optimize performance while supporting centralized data engineering and distributed logic ownership. - - ### Semantic graph We're introducing a new concept: a "semantic graph". It's the relationship between semantic models and YAML configurations that creates a data landscape for building metrics. You can think of it like a map, where tables are like locations, and the connections between them (edges) are like roads. Although it's under the hood, the semantic graph is a subset of the , and you can see the semantic models as nodes on the DAG. @@ -73,6 +55,8 @@ For a semantic model, there are three main pieces of metadata: * [Dimensions](/docs/build/dimensions) — These are the ways you want to group or slice/dice your metrics. * [Measures](/docs/build/measures) — The aggregation functions that give you a numeric result and can be used to create your metrics. + + ### Metrics Metrics, which is a key concept, are functions that combine measures, constraints, or other mathematical functions to define new quantitative indicators. MetricFlow uses measures and various aggregation types, such as average, sum, and count distinct, to create metrics. Dimensions add context to metrics and without them, a metric is simply a number for all time. You can define metrics in the same YAML files as your semantic models, or create a new file. diff --git a/website/docs/docs/build/metricflow-commands.md b/website/docs/docs/build/metricflow-commands.md index 049b415d40e..041ce7a7d5e 100644 --- a/website/docs/docs/build/metricflow-commands.md +++ b/website/docs/docs/build/metricflow-commands.md @@ -6,11 +6,11 @@ sidebar_label: "MetricFlow commands" tags: [Metrics, Semantic Layer] --- -Once you define metrics in your dbt project, you can query metrics, dimensions, dimension values, and validate your configs using the MetricFlow commands. +Once you define metrics in your dbt project, you can query metrics, dimensions, and dimension values, and validate your configs using the MetricFlow commands. MetricFlow allows you to define and query metrics in your dbt project in the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation), [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud), or [dbt Core](/docs/core/installation). To experience the power of the universal [dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl) and dynamically query those metrics in downstream tools, you'll need a dbt Cloud [Team or Enterprise](https://www.getdbt.com/pricing/) account. -MetricFlow is compatible with Python versions 3.8, 3.9, 3.10 and 3.11. +MetricFlow is compatible with Python versions 3.8, 3.9, 3.10, and 3.11. ## MetricFlow @@ -25,7 +25,7 @@ MetricFlow is a dbt package that allows you to define and query metrics in your MetricFlow commands are embedded in the dbt Cloud CLI, which means you can immediately run them once you install the dbt Cloud CLI. -A benefit to using the dbt Cloud CLI or dbt Cloud IDE is that you won't need to manage versioning — your dbt Cloud account will automatically manage the versioning for you. +A benefit to using the dbt Cloud CLI or dbt Cloud IDE is that you won't need to manage versioning — your dbt Cloud account will automatically manage the versioning. @@ -44,11 +44,11 @@ You can create metrics using MetricFlow in the dbt Cloud IDE. However, support f Use the dbt Cloud CLI for the experience in defining and querying metrics in your dbt project on dbt Cloud or dbt Core with MetricFlow. -A benefit to using the dbt Cloud CLI or dbt Cloud IDE is that you won't need to manage versioning — your dbt Cloud account will automatically manage the versioning for you. +A benefit to using the dbt Cloud CLI or dbt Cloud IDE is that you won't need to manage versioning — your dbt Cloud account will automatically manage the versioning. ::: -You can install [MetricFlow](https://github.com/dbt-labs/metricflow#getting-started) from [PyPI](https://pypi.org/project/dbt-metricflow/). You need to use `pip` to instal MetricFlow on Windows or Linux operating systems: +You can install [MetricFlow](https://github.com/dbt-labs/metricflow#getting-started) from [PyPI](https://pypi.org/project/dbt-metricflow/). You need to use `pip` to install MetricFlow on Windows or Linux operating systems: 1. Create or activate your virtual environment`python -m venv venv` 2. Run `pip install dbt-metricflow` @@ -60,6 +60,7 @@ You can install [MetricFlow](https://github.com/dbt-labs/metricflow#getting-star +Something to note, MetricFlow `mf` commands return an error if you have a Metafont latex package installed. To run `mf` commands, uninstall the package. ## MetricFlow commands @@ -552,3 +553,4 @@ Keep in mind that modifying your shell configuration files can have an impact on + diff --git a/website/docs/docs/build/semantic-models.md b/website/docs/docs/build/semantic-models.md index 226c138b545..118e93a26b1 100644 --- a/website/docs/docs/build/semantic-models.md +++ b/website/docs/docs/build/semantic-models.md @@ -18,6 +18,8 @@ Semantic models are the foundation for data definition in MetricFlow, which powe - Configure semantic models in a YAML file within your dbt project directory. - Organize them under a `metrics:` folder or within project sources as needed. + + Semantic models have 6 components and this page explains the definitions with some examples: | Component | Description | Type | diff --git a/website/docs/docs/build/sl-getting-started.md b/website/docs/docs/build/sl-getting-started.md index 34c3479cbc0..64cec11c302 100644 --- a/website/docs/docs/build/sl-getting-started.md +++ b/website/docs/docs/build/sl-getting-started.md @@ -94,3 +94,4 @@ The dbt Semantic Layer is proprietary, however, some components of the dbt Seman - [Build your metrics](/docs/build/build-metrics-intro) - [Get started with the dbt Semantic Layer](/docs/use-dbt-semantic-layer/quickstart-sl) - [Available integrations](/docs/use-dbt-semantic-layer/avail-sl-integrations) +- Demo on [how to define and query metrics with MetricFlow](https://www.loom.com/share/60a76f6034b0441788d73638808e92ac?sid=861a94ac-25eb-4fd8-a310-58e159950f5a) diff --git a/website/docs/docs/use-dbt-semantic-layer/dbt-sl.md b/website/docs/docs/use-dbt-semantic-layer/dbt-sl.md index 8868c68ed20..8c78d556a67 100644 --- a/website/docs/docs/use-dbt-semantic-layer/dbt-sl.md +++ b/website/docs/docs/use-dbt-semantic-layer/dbt-sl.md @@ -43,18 +43,18 @@ plan="dbt Cloud Team or Enterprise" link="/docs/use-dbt-semantic-layer/setup-sl" icon="dbt-bit"/> - - + + diff --git a/website/static/img/docs/dbt-cloud/semantic-layer/semantic_foundation.jpg b/website/static/img/docs/dbt-cloud/semantic-layer/semantic_foundation.jpg new file mode 100644 index 00000000000..51b4a1752eb Binary files /dev/null and b/website/static/img/docs/dbt-cloud/semantic-layer/semantic_foundation.jpg differ