Skip to main content

A tool to generate coembeddings from IF image embeddings and PPI network embeddings

Project description

Cell Maps CoEmbedder

https://img.shields.io/pypi/v/cellmaps_coembedding.svg https://app.travis-ci.com/idekerlab/cellmaps_coembedding.svg?branch=main Documentation Status Zenodo DOI badge

Creates Coembedding from Cell Maps ImmunoFluorscent Image Embedder and Cell Maps PPI Embedder using an implementation of MUSE

Dependencies

Compatibility

  • Python 3.8+

Installation

git clone https://github.com/idekerlab/cellmaps_coembedding
cd cellmaps_coembedding
make dist
pip install dist/cellmaps_coembedding*whl

Run make command with no arguments to see other build/deploy options including creation of Docker image

make

Output:

clean                remove all build, test, coverage and Python artifacts
clean-build          remove build artifacts
clean-pyc            remove Python file artifacts
clean-test           remove test and coverage artifacts
lint                 check style with flake8
test                 run tests quickly with the default Python
test-all             run tests on every Python version with tox
coverage             check code coverage quickly with the default Python
docs                 generate Sphinx HTML documentation, including API docs
servedocs            compile the docs watching for changes
testrelease          package and upload a TEST release
release              package and upload a release
dist                 builds source and wheel package
install              install the package to the active Python's site-packages
dockerbuild          build docker image and store in local repository
dockerpush           push image to dockerhub

Before running tests, please install pip install -r requirements_dev.

For developers

To deploy development versions of this package

Below are steps to make changes to this code base, deploy, and then run against those changes.

  1. Make changes

    Modify code in this repo as desired

  2. Build and deploy

# From base directory of this repo cellmaps_coembedding
pip uninstall cellmaps_coembedding -y ; make clean dist; pip install dist/cellmaps_coembedding*whl

Needed files

The output directories for the image embeddings (see Cell Maps Image Embedding) and protein-protein interaction network embeddings (see Cell Maps PPI Embedding) are required.

Usage

For information invoke cellmaps_coembeddingcmd.py -h

Example usage

cellmaps_coembeddingcmd.py ./cellmaps_coembedding_outdir --embeddings ./cellmaps_image_embedding_outdir ./cellmaps_ppi_embedding_outdir

Via Docker

Example usage

Coming soon...

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.3.1 (2024-09-13)

  • Bug fix: raise more informative error when no embeddings overlap.

0.3.0 (2024-09-06)

  • Added --provenance flag to pass a path to json file with provenance information. This removes the necessity of input directory to be an RO-Crate.

0.2.0 (2024-07-17)

  • Added a new coembedding algorithm accessible via flag --algorithm auto. This algorithm utilizes neural networks to generate latent embeddings, optimizing both reconstruction and triplet losses to improve embedding accuracy by learning intra- and inter-modality relationships.

0.1.0 (2024-02-12)

  • First release on PyPI.

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

cellmaps_coembedding-0.3.1.tar.gz (47.2 kB view details)

Uploaded Source

Built Distribution

cellmaps_coembedding-0.3.1-py2.py3-none-any.whl (33.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file cellmaps_coembedding-0.3.1.tar.gz.

File metadata

  • Download URL: cellmaps_coembedding-0.3.1.tar.gz
  • Upload date:
  • Size: 47.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.18

File hashes

Hashes for cellmaps_coembedding-0.3.1.tar.gz
Algorithm Hash digest
SHA256 0c95cc50d1e90b511b22b24cb6e24ade36b14020a34e7235ed5257f76a2dd154
MD5 906396182129b2cdf5fc7fc2b8f33307
BLAKE2b-256 c73b0848ae2688e7069c963a1567710cc3577124b380abc8e6974081f98a3351

See more details on using hashes here.

File details

Details for the file cellmaps_coembedding-0.3.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for cellmaps_coembedding-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4eda5b16c4a92708822b6d5ba6ee94ee24d138112cca3984c58fbf9ed0e74156
MD5 a19992a25dd33d41bccec64fb48fd4c1
BLAKE2b-256 00b86e881561c89e9d33b8b766bc84f02315e2deef4fe7d9ff99e154e02e91bd

See more details on using hashes here.

Supported by

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