Model packaging (.mar files) in PyTorch - Model Pipeline Trace

Model Pipeline - Model packaging (.mar files)

This pipeline shows how a PyTorch model is packaged into a .mar file for easy deployment. The model is trained, saved, then packaged with metadata and dependencies into a .mar archive. This archive can be loaded by serving tools to make predictions.

Data Flow - 4 Stages

1Train Model

1000 rows x 20 features→Train a PyTorch neural network on input data→Model weights saved as .pt file

Input: feature vectors of size 20; Output: trained model weights file model.pt

↓

2Save Model Script

Model weights file (.pt)→Save model architecture and weights in a scripted format→Scripted model file (.pt)

torch.jit.script(model) saved as scripted_model.pt

↓

3Create MAR Archive

Scripted model file + extra files (handler, config)→Package model and metadata into a .mar archive using torch-model-archiver→Model archive file (.mar)

torch-model-archiver --model-name my_model --version 1.0 --serialized-file scripted_model.pt --handler handler.py --export-path model_store

↓

4Deploy MAR File

Model archive file (.mar)→Load .mar file into TorchServe for serving predictions→Model ready to serve predictions

torchserve --start --model-store model_store --models my_model=my_model.mar

Training Trace - Epoch by Epoch

Epoch 1: 0.85 *****
Epoch 2: 0.60 ****
Epoch 3: 0.45 ***
Epoch 4: 0.35 **
Epoch 5: 0.30 *

Epoch	Loss ↓	Accuracy ↑	Observation
1	0.85	0.60	Initial training with high loss and moderate accuracy
2	0.60	0.75	Loss decreased, accuracy improved
3	0.45	0.82	Model learning well, loss dropping
4	0.35	0.88	Good convergence, accuracy nearing 90%
5	0.30	0.90	Training converged with low loss and high accuracy

Prediction Trace - 4 Layers

Layer 1: Input preprocessing

Layer 2: Model forward pass

Layer 3: Softmax activation

Layer 4: Prediction output

Model Quiz - 3 Questions

What is the main purpose of the .mar file in this pipeline?

A To package the model and metadata for deployment

B To train the model faster

C To store raw training data

D To visualize model predictions

Key Insight

Packaging a PyTorch model into a .mar file bundles the model code, weights, and metadata into one deployable archive. This makes it easy to serve the model in production environments with tools like TorchServe, ensuring consistent and efficient predictions.

Practice

1. What is the main purpose of packaging a PyTorch model into a .mar file?

easy

A. To visualize the model architecture

B. To convert the model into a different training format

C. To compress the model for storage only

D. To bundle the model and code for easy deployment with TorchServe

Solution

1. Step 1: Understand what a .mar file contains

   A .mar file bundles the trained model and the handler code needed to serve it.

2. Step 2: Identify the use case of .mar files

   These files are used by TorchServe to deploy models as APIs easily.

3. Final Answer:

   To bundle the model and code for easy deployment with TorchServe -> Option D

4. Quick Check:

   Model packaging = deployment bundle [OK]

Hint: Think deployment: .mar bundles model + code [OK]

Common Mistakes:

• Confusing .mar with just compression
• Thinking .mar changes training format
• Assuming .mar is for visualization

2. Which command correctly creates a .mar file using torch-model-archiver?

easy

A. torch-model-archiver --model-name mymodel --model-file model.pth --handler handler.py --export-path model_store

B. torch-model-archiver --model-name mymodel --model-file model.pth --handler handler.txt --export-path model_store

C. torch-model-archiver --model-name mymodel --model-file model.txt --handler handler.py --export-path model_store

D. torch-model-archiver --model-name mymodel --model-file model.py --handler handler.py --export-path model_store

Solution

1. Step 1: Identify correct model file type

   The model file should be a PyTorch model file like .pth, not a Python script or text file.

2. Step 2: Confirm handler file type

   The handler must be a Python script .py, not a text file.

3. Final Answer:

   torch-model-archiver --model-name mymodel --model-file model.pth --handler handler.py --export-path model_store -> Option A

4. Quick Check:

   Model file = .pth, handler = .py [OK]

Hint: Model file is .pth, handler is .py script [OK]

Common Mistakes:

• Using .py file as model file
• Using .txt as handler file
• Mixing file extensions incorrectly

3. Given this command:

torch-model-archiver --model-name resnet --model-file resnet.pth --handler image_classifier.py --export-path model_store

What will be the output?

medium

A. A Python script named resnet.py created

B. An error because resnet.pth is not a valid model file

C. A file named resnet.mar created in model_store directory

D. A folder named resnet.mar created

Solution

1. Step 1: Understand torch-model-archiver output

   The command packages the model and handler into a single .mar file.

2. Step 2: Check output location and file name

   The .mar file is named after the model name and saved in the export path.

3. Final Answer:

   A file named resnet.mar created in model_store directory -> Option C

4. Quick Check:

   .mar file = model + handler bundle [OK]

Hint: Output is a .mar file named after model [OK]

Common Mistakes:

• Expecting a Python script output
• Thinking .mar is a folder
• Assuming error due to .pth file

4. You ran this command:

torch-model-archiver --model-name mymodel --model-file model.pth --handler handler.py --export-path model_store

But got an error: Handler file not found. What is the likely cause?

medium

A. The handler.py file is missing or path is incorrect

B. The model.pth file is corrupted

C. The export path model_store does not exist

D. The model name contains invalid characters

Solution

1. Step 1: Analyze the error message

   The error says handler file not found, so the problem is with the handler.py file location or name.

2. Step 2: Check other options

   Model file corruption or export path issues would cause different errors, not handler missing.

3. Final Answer:

   The handler.py file is missing or path is incorrect -> Option A

4. Quick Check:

   Error message = handler file missing [OK]

Hint: Check handler file path if 'Handler file not found' error occurs [OK]

Common Mistakes:

• Blaming model file for handler error
• Ignoring file path correctness
• Assuming export path causes handler error

5. You want to package two different PyTorch models with custom handlers into .mar files for TorchServe. Which approach correctly packages both models for deployment?

hard

A. Package one model as .mar and copy the second model file into the model_store folder without packaging

B. Run torch-model-archiver twice, each time with the respective model file, handler, and unique model name, exporting to the same model_store folder

C. Combine both models into one .pth file and use a single handler to package once

D. Use torch-model-archiver once with both model files and handlers listed separated by commas

Solution

1. Step 1: Understand packaging multiple models

   Each model requires its own .mar file with its specific handler and unique model name.

2. Step 2: Confirm correct packaging method

   Running torch-model-archiver twice with different parameters and exporting to the same folder is the correct way.

3. Final Answer:

   Run torch-model-archiver twice, each time with the respective model file, handler, and unique model name, exporting to the same model_store folder -> Option B

4. Quick Check:

   One .mar per model + handler [OK]

Hint: Package each model separately with unique names [OK]

Common Mistakes:

• Trying to combine models in one .mar file
• Copying model files without packaging
• Passing multiple files in one command