使用cev的比较嵌入可视化

安装

警告： cev是新项目，正在积极开发中。它尚未准备好投入生产，API可能随时更改。

pip install cev

入门

import pandas as pd
from cev.widgets import Embedding, EmbeddingComparisonWidget

umap_embedding = Embedding.from_ozette(df=pd.read_parquet("../data/mair-2022-tissue-138-umap.pq"))
ozette_embedding = Embedding.from_ozette(df=pd.read_parquet("../data/mair-2022-tissue-138-ozette.pq"))

umap_vs_ozette = EmbeddingComparisonWidget(
    umap_embedding,
    ozette_embedding,
    titles=["Standard UMAP", "Annotation-Transformed UMAP"],
    metric="confusion",
    selection="synced",
    auto_zoom=True,
    row_height=320,
)
umap_vs_ozette

请参阅notebooks/getting-started.ipynb以获取完整示例。

开发

首先，使用所有必需的依赖项创建虚拟环境。我们强烈建议使用hatch，它将自动安装并同步所有来自pyproject.toml的依赖项。

hatch shell

或者，您也可以使用conda。

conda env create -n cev python=3.11
conda activate cev

接下来，使用所有开发资产安装cev。

pip install -e ".[notebooks,dev]"

最后，您现在可以使用以下命令运行笔记本：

jupyterlab

命令速查表

如果使用 hatch CLI，则在默认环境中可使用以下命令：

或者，您可以通过手动创建虚拟环境和使用 pip 管理依赖项来开发 cev。

我们的 CI 代码风格/格式化检查使用 pre-commit 配置。我们建议安装 git 钩子脚本来允许在 git commit 时自动运行 pre-commit。

pre-commit install # run this once to install the git hooks

这将确保推送到 CI 的代码符合我们的代码风格和格式化标准。不符合标准的代码将在 CI 中失败。

发布

发布通过标记提交触发

git tag -a vX.X.X -m "vX.X.X"
git push --follow-tags

许可证

cev 根据 Apache License 2.0 条款分发。