Skip to main content

Deep Multiple Instance Learning library for Pytorch

Project description

torchmil

License Contributors Release

torchmil is a PyTorch-based library for deep Multiple Instance Learning (MIL). It provides a simple, flexible, and extensible framework for working with MIL models and data.

It includes:

Installation

pip install torchmil

Quick start

You can load a MIL dataset and train a MIL model in just a few lines of code:

from torchmil.datasets import Camelyon16MIL
from torchmil.models import ABMIL
from torchmil.utils import Trainer
from torchmil.data import collate_fn
from torch.utils.data import DataLoader

# Load the Camelyon16 dataset
dataset = Camelyon16MIL(root='data', features='UNI')
dataloader = DataLoader(dataset, batch_size=4, shuffle=True, collate_fn=collate_fn)

# Instantiate the ABMIL model and optimizer
model = ABMIL(in_shape=(2048,), criterion=torch.nn.BCEWithLogitsLoss()) # each model has its own criterion
optimizer = torch.optim.Adam(model.parameters(), lr=1e-4)

# Instantiate the Trainer
trainer = Trainer(model, optimizer, device='cuda')

# Train the model
trainer.train(dataloader, epochs=10)

# Save the model
torch.save(model.state_dict(), 'model.pth')

Next steps

You can take a look at the examples to see how to use torchmil in practice. To see the full list of available models, datasets, and modules, check the API reference.

Contributing to torchmil

We welcome contributions to torchmil! There are several ways you can contribute:

  • Reporting bugs or issues you encounter while using the library, asking questions, or requesting new features: use the Github issues.
  • Improving the documentation: if you find any part of the documentation unclear or incomplete, feel free to submit a pull request with improvements.
  • If you have a new model, dataset, or utility that you think would be useful for the community, please consider submitting a pull request to add it to the library.

Take a look at CONTRIBUTING.md for more details on how to contribute.

Citation

If you find this library useful, please consider citing it:

@article{castro2025torchmil,
  title={torchmil: A PyTorch-based library for deep Multiple Instance Learning},
  author={Castro-Mac{\'\i}as, Francisco M and S{\'a}ez-Maldonado, Francisco J and Morales-{\'A}lvarez, Pablo and Molina, Rafael},
  journal={arXiv preprint arXiv:2509.08129},
  year={2025}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

torchmil-1.0.1.tar.gz (133.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

torchmil-1.0.1-py3-none-any.whl (210.0 kB view details)

Uploaded Python 3

File details

Details for the file torchmil-1.0.1.tar.gz.

File metadata

  • Download URL: torchmil-1.0.1.tar.gz
  • Upload date:
  • Size: 133.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for torchmil-1.0.1.tar.gz
Algorithm Hash digest
SHA256 e431b7f4d8343e76bc2ace56b6639790c8d679cd6561f390708a9f33f10b5b84
MD5 dae2e127577f2a3051eec41f709b2a9d
BLAKE2b-256 18b6e5ffa7b3285c30fe0e993fb02555d16ae3d602b130c8be70b5648b002058

See more details on using hashes here.

File details

Details for the file torchmil-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: torchmil-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 210.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for torchmil-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 333f4218d3490f136348451283f203fdef7be0eca91058a99486ea5db4f03c06
MD5 e8d4f7cfdf3c2fdbf05d49ceb892960d
BLAKE2b-256 db438141d39ed2804f5ebe8264781fdaa7a6db9d683d9a7acf0cb4fbac40d6d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page