Merlin TensorFlow Jupyter Notebooks

These example notebooks demonstrate how to use NVTabular with HugeCTR. Each example provides details about the end-to-end workflow, which includes Download data, ETL, and Training.

About Quick Deploy

The quick deploy feature automatically sets up the Vertex AI instance with an optimal configuration, preloads the dependencies, runs the software from NGC without any need to set up the infrastructure.

Each example notebook is structured as follows:

1. 01-Download-Convert.ipynb: Demonstrates how to download the dataset and convert it into the correct format so that it can be consumed.
2. 02-ETL-with-NVTabular.ipynb: Demonstrates how to execute the preprocessing and feature engineering pipeline (ETL) with NVTabular on the GPU.
3. 03-Training-with-TF.ipynb: Demonstrates how to train a model with TensorFlow based on the ETL output.
4. MM-01-Getting-started.ipynb: Demonstrates Merlin Models by training Facebook's DLRM architecture with only 3 commands.
5. MM-02-Merlin-Models-and-NVTabular-integration.ipynb: Demonstrates how NVTabular and Merlin Models can be integrated together.
6. MM-03-Exploring-different-models.ipynb: Demonstrate how to build and train several popular deep learning-based ranking model architectures.
7. MM-04-Exporting-ranking-models.ipynb: Demonstrates how to export (save) NVTabular workflow and a ranking model for model deployment with Merlin Systems library.
8. MM-05-Retrieval-Model.ipynb: Demonstrates how to build a Two-Tower model for Item Retrieval task using synthetic datasets
9. MM-06-Define-your-own-architecture-with-Merlin-Models.ipynb: Demonstrates how to combine pre-existing blocks and create a custom DLRM architecture.
10. MM-07-Train-traditional-ML-models-using-the-Merlin-Models-API.ipynb: Demonstrates how to train several traditional ML models using Merlin Models.​​​​​​

Deploying the notebooks

To deploy these notebooks with the optimal configuration to the cloud please click the "deploy" button on the top right of NGC.

Reading the notebook without leaving NGC

If you want to read through the notebook example without leaving our website, follow these steps:

1. Navigate to the File Browser tab of the asset in NGC
2. Select the version you'd like to see
3. Next to the .ipynb file select "View Jupyter"
4. There you have it! You can read a notebook for documentation and copy code samples without ever leaving NGC.
5. All the instructions you need to get started are in the resource - so head over and see how to get up and running.