User Guide#
Welcome to the Data Federation Mesh (DFM) user guide. This guide documents the package and its design.
Quick Start#
Install#
Install the core DFM package:
pip install nv-dfm-core
Verify Installation#
dfm --version
dfm --help
To follow the rest of this quick-start guide, clone the repository and install from source:
git clone https://github.com/NVIDIA/data-federation-mesh.git
cd data-federation-mesh
uv sync --package nv-dfm-core
Tip
For detailed installation options — including installing individual packages, tutorial extras, and weather adapter dependencies — see the Installation page.
Run the Example (Local Target)#
From tutorials/example-fed:
# Activate the virtual environment
source .venv/bin/activate
# Install the example federation package in editable mode
uv pip install -e tutorials/example-fed
# Run the example application
python tutorials/example-fed/examplefed/apps/concierge.py --target local --name 'DFM-Test' --greetme-from app --message 'Hello, User!'
You should expect the following output:
Executing the GreetMe that's specialized on the concierge homesite with custom message
Received greeting from concierge for place 'yield', frame token='@dfm-control-token' frame=[0]:
Hello, User!
Received stop of call frame [0]
Received overall pipeline stop frame
Job (hopefully) finished with status FINISHED: JobStatus.FINISHED
The concierge app says goodbye!
Run the Example (Distributed POC Mode)#
Run the same example with a local distributed deployment:
# Start the simulated distributed environment (POC mode); make sure the virtual environment is activated
dfm poc start --federation examplefed
python tutorials/example-fed/examplefed/apps/concierge.py --target flare --name 'DFM-Test' --greetme-from reception --federation-path workspace/examplefed_poc/examplefed/
You should expect the following output:
Executing the general GreetMe on site reception
Site info for reception doesn't have send cost info to site 'concierge'. Using suboptimal default info.
Site info for reception doesn't have send cost info to site 'concierge'. Using suboptimal default info.
Received greeting from reception for place 'yield':
Welcome to the reception desk at examplefed, DFM-Test. Today is Thursday, 2025-04-17 and it is 10 o'clock. We hope you are having a good experience.
Received stop of call frame [0]
Received overall pipeline stop frame
Job (hopefully) finished with status FINISHED: JobStatus.FINISHED
The concierge app says goodbye!
To stop the local distributed deployment:
dfm poc stop
Tip
To learn more, continue with the Zero to Thirty tutorial.