Compare commits

...
Author SHA1 Message Date
Andrew Tolopko a9ef01a6f9 fix test (#2549)
address issues building mlflow model in GHA test env
2022-07-29 11:17:04 -04:00
Andrew Tolopko 03d9e8e6aa fix unit test
avoid performing pip installs for mlflow-based tests
2022-07-29 09:57:55 -04:00
Andrew Tolopko 30e19e47c6 feat: add cli annotation subcommand (#2539)
add `cellxgene annotate` subcommand for invoking MLflow model to generate new `obs` annotations, initially intended for cell type annotations.
2022-07-29 05:15:54 -07:00
Emanuele Bezzi d2b20129f7 use fsspec.download for S3 artifacts + additional logging (#2536) 2022-07-29 11:05:36 +00:00
Rohan Agarwal 6c86216f6b Update actions/setup-python version (#2528) 2022-07-28 21:17:46 +00:00
Andrew Tolopko 4df50a7677 fix: s3 user annotations (#2541)
do _not_ attempt to create the user annotations directory if an s3 location is specified
2022-07-28 20:00:15 +00:00
Andrew Tolopko 69a6d52240 fix embedding selection (#2543)
reverted code to previous implementation that was presumably changed due to a "destructuring assignment" lint error; explicitly ignoring error now
2022-07-28 15:49:33 -04:00
Andrew Tolopko 06da05eb9f skip failing tests to unblock adding of new features (#2545)
skipped tests will be reinstated in future issues
2022-07-28 15:11:36 -04:00
Severiano BadajozandSeve Badajoz d753441acc chore(webpack): remove script-ext-html-webpack-plugin (#2534)
Co-authored-by: Seve Badajoz <severiano.badajoz@chanzuckerberg.com>
2022-07-12 13:42:20 -04:00
8b4c1e418e chore: replace optimize-css-assets-webpack-plugin with css-minimizer-webpack-plugin (#2525)
* Replace optimize-css-assets-webpack-plugin with css-minimizer-webpack-plugin

* Fix lint issues in JS

* remove favicons

* update snapshots

* update annotations snapshots

Co-authored-by: Trent Smith <1429913+Bento007@users.noreply.github.com>
Co-authored-by: Seve Badajoz <sbadajoz@chanzuckerberg.com>
2022-06-07 13:13:17 -07:00
Madison Dunitz f2bd6ebce1 remove unnecessary postgres req (#2524) 2022-05-27 12:15:17 -07:00
Bruce Martin de44739f8b add fsspec support to gene set and cell annotations (#2512) 2022-04-20 18:18:47 -07:00
Severiano Badajoz 002c9a5c7f release version 1.0.1 (#2497)
* Bump version: 1.0.0 → 1.0.1-rc.0

* Bump version: 1.0.1-rc.0 → 1.0.1
2022-02-28 15:18:21 -08:00
dependabot[bot] e6a0351079 chore(deps): bump nanoid from 3.1.25 to 3.3.1 in /client (#2488)
Bumps [nanoid](https://github.com/ai/nanoid) from 3.1.25 to 3.3.1.
- [Release notes](https://github.com/ai/nanoid/releases)
- [Changelog](https://github.com/ai/nanoid/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ai/nanoid/compare/3.1.25...3.3.1)

---
updated-dependencies:
- dependency-name: nanoid
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-02-25 09:57:22 -08:00
dependabot[bot] 38fdc649f5 chore(deps): bump axios from 0.21.1 to 0.21.4 in /client (#2491)
Bumps [axios](https://github.com/axios/axios) from 0.21.1 to 0.21.4.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/master/CHANGELOG.md)
- [Commits](https://github.com/axios/axios/compare/v0.21.1...v0.21.4)

---
updated-dependencies:
- dependency-name: axios
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-02-24 14:20:17 -08:00
dependabot[bot] 69a5d5e837 chore(deps): bump tmpl from 1.0.4 to 1.0.5 in /client (#2490)
Bumps [tmpl](https://github.com/daaku/nodejs-tmpl) from 1.0.4 to 1.0.5.
- [Release notes](https://github.com/daaku/nodejs-tmpl/releases)
- [Commits](https://github.com/daaku/nodejs-tmpl/commits/v1.0.5)

---
updated-dependencies:
- dependency-name: tmpl
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-02-24 14:05:26 -08:00
dependabot[bot] b854c58eea chore(deps): bump simple-get from 3.1.0 to 3.1.1 in /client (#2489)
Bumps [simple-get](https://github.com/feross/simple-get) from 3.1.0 to 3.1.1.
- [Release notes](https://github.com/feross/simple-get/releases)
- [Commits](https://github.com/feross/simple-get/compare/v3.1.0...v3.1.1)

---
updated-dependencies:
- dependency-name: simple-get
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-02-24 13:46:07 -08:00
dependabot[bot] 2d650ba50d chore(deps): bump follow-redirects from 1.14.2 to 1.14.8 in /client (#2484)
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.2 to 1.14.8.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.14.2...v1.14.8)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-02-24 11:57:08 -08:00
Ben MR 8bac98f25c Fix float16 support [#2379] (#2483)
* Fix float16 support [#2379]

Convert to float32 on startup unless backed, in which case error. scipy does not support complex slicing from float16 data so this is the easiest fix for now.

* minor msg change
2022-02-10 15:20:47 -08:00
maniarathi ceb0cc6f27 Update license to 2022. (#2478) 2022-01-14 14:07:35 -05:00
38 changed files with 7697 additions and 19200 deletions
+1 -1
View File
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 1.0.0
current_version = 1.0.1
commit = True
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<prerel>rc)\.(?P<prerelversion>\d+))?
serialize =
+2 -2
View File
@@ -16,7 +16,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Build docker image
@@ -56,7 +56,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Cache env vars
+37 -34
View File
@@ -18,7 +18,7 @@ jobs:
- run: |
git fetch --depth=1 origin +${{github.base_ref}}
- name: Set up Python 3.7
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: 3.7
- name: Node cache
@@ -46,10 +46,12 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.7
uses: actions/setup-python@v1
- name: Set up Python 3.7 (pyenv) # pyenv needed for mlflow in cli annotate tests
uses: gabrielfalcao/pyenv-action@v9
with:
python-version: 3.7
default: 3.7
command: pip install -U pip # upgrade pip after installing python
- run: pip install virtualenv # virtualenv needed for mlflow in cli annotate tests
- name: Python cache
uses: actions/cache@v1
with:
@@ -78,7 +80,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.7
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: 3.7
- name: Python cache
@@ -102,32 +104,33 @@ jobs:
cd client && make smoke-test
./node_modules/codecov/bin/codecov --yml=../.codecov.yml --root=../ --gcov-root=../ -C -F frontend,javascript,smokeTest
smoke-tests-annotations:
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.7
uses: actions/setup-python@v1
with:
python-version: 3.7
- name: Python cache
uses: actions/cache@v1
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Node cache
uses: actions/cache@v1
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- name: Install dependencies
run: make pydist install-dist
- name: Smoke tests (with annotations feature)
run: |
cd client && make smoke-test-annotations
./node_modules/codecov/bin/codecov --yml=../.codecov.yml --root=../ --gcov-root=../ -C -F frontend,javascript,smokeTestAnnotations
# TODO: reinstate: https://github.com/chanzuckerberg/cellxgene/issues/2544
# smoke-tests-annotations:
# runs-on: ubuntu-latest
# timeout-minutes: 20
# steps:
# - uses: actions/checkout@v2
# - name: Set up Python 3.7
# uses: actions/setup-python@v4
# with:
# python-version: 3.7
# - name: Python cache
# uses: actions/cache@v1
# with:
# path: ~/.cache/pip
# key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }}
# restore-keys: |
# ${{ runner.os }}-pip-
# - name: Node cache
# uses: actions/cache@v1
# with:
# path: ~/.npm
# key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
# restore-keys: |
# ${{ runner.os }}-node-
# - name: Install dependencies
# run: make pydist install-dist
# - name: Smoke tests (with annotations feature)
# run: |
# cd client && make smoke-test-annotations
# ./node_modules/codecov/bin/codecov --yml=../.codecov.yml --root=../ --gcov-root=../ -C -F frontend,javascript,smokeTestAnnotations
+3
View File
@@ -54,3 +54,6 @@ client/.eslintcache
# E2E Testing
ignoreE2E*
# annotate subcmd
.models_cache
+1 -1
View File
@@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2017-2021 Chan Zuckerberg Initiative
Copyright (c) 2017-2022 Chan Zuckerberg Initiative
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
+1
View File
@@ -3,5 +3,6 @@ recursive-include server/common/web/static *
include server/requirements.txt
include server/requirements-prepare.txt
include server/requirements-annotate.txt
include server/converters/schema/hgnc_complete_set.txt.gz
include server/converters/schema/schema_definitions/*
@@ -2,4 +2,4 @@
exports[`did launch page launched 1`] = `"<span style=\\"max-width: 155px; display: flex; overflow: hidden; justify-content: flex-start; width: 100%; padding: 0px;\\"><span style=\\"overflow: hidden; text-overflow: ellipsis; white-space: nowrap; flex-shrink: 1; min-width: 5px;\\">pbm</span><span style=\\"position: relative; overflow: hidden; white-space: nowrap;\\"><span style=\\"color: transparent;\\">c3k</span><span style=\\"position: absolute; right: 0px; color: inherit;\\">c3k</span></span></span>"`;
exports[`metadata loads categories and values from dataset appear 1`] = `"<div style=\\"display: flex; justify-content: space-between; align-items: baseline;\\"><div style=\\"display: flex; justify-content: flex-start; align-items: flex-start;\\"><label class=\\"bp3-control bp3-checkbox\\" for=\\"category-select-louvain\\"><input id=\\"category-select-louvain\\" data-testclass=\\"category-select\\" data-testid=\\"louvain:category-select\\" type=\\"checkbox\\" checked=\\"\\"><span class=\\"bp3-control-indicator\\"></span></label><span role=\\"menuitem\\" tabindex=\\"0\\" data-testclass=\\"category-expand\\" data-testid=\\"louvain:category-expand\\" style=\\"cursor: pointer;\\"><span aria-haspopup=\\"true\\" class=\\"bp3-popover2-target\\"><span data-testid=\\"louvain:category-label\\" tabindex=\\"-1\\" aria-label=\\"louvain\\" class=\\"\\" style=\\"max-width: 265px;\\"><span style=\\"max-width: 265px; display: flex; overflow: hidden; justify-content: flex-start; width: 100%; padding: 0px;\\"><span style=\\"overflow: hidden; text-overflow: ellipsis; white-space: nowrap; flex-shrink: 1; min-width: 5px;\\">lou</span><span style=\\"position: relative; overflow: hidden; white-space: nowrap;\\"><span style=\\"color: transparent;\\">vain</span><span style=\\"position: absolute; right: 0px; color: inherit;\\">vain</span></span></span></span></span><svg stroke=\\"currentColor\\" fill=\\"currentColor\\" stroke-width=\\"0\\" viewBox=\\"0 0 320 512\\" data-testclass=\\"category-expand-is-not-expanded\\" height=\\"1em\\" width=\\"1em\\" xmlns=\\"http://www.w3.org/2000/svg\\" style=\\"font-size: 10px; margin-left: 5px;\\"><path d=\\"M285.476 272.971L91.132 467.314c-9.373 9.373-24.569 9.373-33.941 0l-22.667-22.667c-9.357-9.357-9.375-24.522-.04-33.901L188.505 256 34.484 101.255c-9.335-9.379-9.317-24.544.04-33.901l22.667-22.667c9.373-9.373 24.569-9.373 33.941 0L285.475 239.03c9.373 9.372 9.373 24.568.001 33.941z\\"></path></svg></span></div><div><span class=\\"bp3-popover-wrapper\\"><span aria-haspopup=\\"true\\" class=\\"bp3-popover-target\\"><a role=\\"button\\" data-testclass=\\"colorby\\" data-testid=\\"colorby-louvain\\" class=\\"bp3-button\\" tabindex=\\"0\\"><span icon=\\"tint\\" class=\\"bp3-icon bp3-icon-tint\\"><svg data-icon=\\"tint\\" width=\\"16\\" height=\\"16\\" viewBox=\\"0 0 16 16\\"><desc>tint</desc><path d=\\"M7.88 1s-4.9 6.28-4.9 8.9c.01 2.82 2.34 5.1 4.99 5.1 2.65-.01 5.03-2.3 5.03-5.13C12.99 7.17 7.88 1 7.88 1z\\" fill-rule=\\"evenodd\\"></path></svg></span></a></span></span></div></div><div style=\\"margin-left: 26px;\\"></div>"`;
exports[`metadata loads categories and values from dataset appear 1`] = `"<div style=\\"display: flex; justify-content: space-between; align-items: baseline;\\"><div style=\\"display: flex; justify-content: flex-start; align-items: flex-start;\\"><label class=\\"bp3-control bp3-checkbox\\" for=\\"category-select-louvain\\"><input id=\\"category-select-louvain\\" data-testclass=\\"category-select\\" data-testid=\\"louvain:category-select\\" type=\\"checkbox\\" checked=\\"\\"><span class=\\"bp3-control-indicator\\"></span></label><span role=\\"menuitem\\" tabindex=\\"0\\" data-testclass=\\"category-expand\\" data-testid=\\"louvain:category-expand\\" style=\\"cursor: pointer;\\"><span aria-haspopup=\\"true\\" class=\\"bp3-popover2-target\\"><span data-testid=\\"louvain:category-label\\" tabindex=\\"-1\\" aria-label=\\"louvain\\" class=\\"\\" style=\\"max-width: 265px;\\"><span style=\\"max-width: 265px; display: flex; overflow: hidden; justify-content: flex-start; width: 100%; padding: 0px;\\"><span style=\\"overflow: hidden; text-overflow: ellipsis; white-space: nowrap; flex-shrink: 1; min-width: 5px;\\">lou</span><span style=\\"position: relative; overflow: hidden; white-space: nowrap;\\"><span style=\\"color: transparent;\\">vain</span><span style=\\"position: absolute; right: 0px; color: inherit;\\">vain</span></span></span></span></span><svg stroke=\\"currentColor\\" fill=\\"currentColor\\" stroke-width=\\"0\\" viewBox=\\"0 0 320 512\\" data-testclass=\\"category-expand-is-not-expanded\\" height=\\"1em\\" width=\\"1em\\" xmlns=\\"http://www.w3.org/2000/svg\\" style=\\"font-size: 10px; margin-left: 5px;\\"><path d=\\"M285.476 272.971L91.132 467.314c-9.373 9.373-24.569 9.373-33.941 0l-22.667-22.667c-9.357-9.357-9.375-24.522-.04-33.901L188.505 256 34.484 101.255c-9.335-9.379-9.317-24.544.04-33.901l22.667-22.667c9.373-9.373 24.569-9.373 33.941 0L285.475 239.03c9.373 9.372 9.373 24.568.001 33.941z\\"></path></svg></span></div><div><span class=\\"bp3-popover-wrapper\\"><span aria-haspopup=\\"true\\" class=\\"bp3-popover-target\\"><a role=\\"button\\" data-testclass=\\"colorby\\" data-testid=\\"colorby-louvain\\" class=\\"bp3-button\\" tabindex=\\"0\\"><span icon=\\"tint\\" aria-hidden=\\"true\\" tabindex=\\"0\\" class=\\"bp3-icon bp3-icon-tint\\"><svg data-icon=\\"tint\\" width=\\"16\\" height=\\"16\\" viewBox=\\"0 0 16 16\\"><path d=\\"M7.88 1s-4.9 6.28-4.9 8.9c.01 2.82 2.34 5.1 4.99 5.1 2.65-.01 5.03-2.3 5.03-5.13C12.99 7.17 7.88 1 7.88 1z\\" fill-rule=\\"evenodd\\"></path></svg></span></a></span></span></div></div><div style=\\"margin-left: 26px;\\"></div>"`;
File diff suppressed because one or more lines are too long
@@ -1,8 +1,6 @@
const path = require("path");
const webpack = require("webpack");
const HtmlWebpackPlugin = require("html-webpack-plugin");
const FaviconsWebpackPlugin = require("favicons-webpack-plugin");
const ScriptExtHtmlWebpackPlugin = require("script-ext-html-webpack-plugin");
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
const { merge } = require("webpack-merge");
@@ -44,21 +42,6 @@ const devConfig = {
inject: true,
template: path.resolve("index.html"),
}),
new FaviconsWebpackPlugin({
logo: "./favicon.png",
prefix: "static/img/",
favicons: {
icons: {
android: false,
appleIcon: false,
appleStartup: false,
coast: false,
firefox: false,
windows: false,
yandex: false,
},
},
}),
new MiniCssExtractPlugin({
filename: "static/[name].css",
}),
@@ -73,9 +56,6 @@ const devConfig = {
CXG_SERVER_PORT: process.env.CXG_SERVER_PORT || "5005",
}),
}),
new ScriptExtHtmlWebpackPlugin({
async: "obsolete",
}),
],
infrastructureLogging: {
level: "warn",
@@ -3,9 +3,7 @@ const webpack = require("webpack");
const HtmlWebpackPlugin = require("html-webpack-plugin");
const { CleanWebpackPlugin } = require("clean-webpack-plugin");
const TerserJSPlugin = require("terser-webpack-plugin");
const CleanCss = require("clean-css");
const OptimizeCSSAssetsPlugin = require("optimize-css-assets-webpack-plugin");
const FaviconsWebpackPlugin = require("favicons-webpack-plugin");
const CssMinimizerPlugin = require("css-minimizer-webpack-plugin");
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
const { merge } = require("webpack-merge");
@@ -29,8 +27,8 @@ const prodConfig = {
minimize: true,
minimizer: [
new TerserJSPlugin({}),
new OptimizeCSSAssetsPlugin({
cssProcessor: CleanCss,
new CssMinimizerPlugin({
minify: CssMinimizerPlugin.cleanCssMinify,
}),
],
},
@@ -66,21 +64,6 @@ const prodConfig = {
protectWebpackAssets: false,
cleanAfterEveryBuildPatterns: ["main.js", "main.css"],
}),
new FaviconsWebpackPlugin({
logo: "./favicon.png",
prefix: "static/assets/",
favicons: {
icons: {
android: false,
appleIcon: false,
appleStartup: false,
coast: false,
firefox: false,
windows: false,
yandex: false,
},
},
}),
new MiniCssExtractPlugin({
filename: "static/[name]-[contenthash].css",
}),
@@ -2,8 +2,6 @@ const path = require("path");
const fs = require("fs");
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
const ObsoleteWebpackPlugin = require("obsolete-webpack-plugin");
// eslint-disable-next-line @blueprintjs/classes-constants -- incorrect match
const ScriptExtHtmlWebpackPlugin = require("script-ext-html-webpack-plugin");
const src = path.resolve("src");
const nodeModules = path.resolve("node_modules");
@@ -67,8 +65,5 @@ module.exports = {
template: obsoleteHTMLTemplate,
promptOnNonTargetBrowser: false,
}),
new ScriptExtHtmlWebpackPlugin({
async: "obsolete",
}),
],
};
+7108 -19010
View File
File diff suppressed because it is too large Load Diff
+2 -5
View File
@@ -1,6 +1,6 @@
{
"name": "cellxgene",
"version": "1.0.0",
"version": "1.0.1",
"license": "MIT",
"description": "cellxgene is a web application for the interactive exploration of single cell sequence data.",
"repository": "https://github.com/chanzuckerberg/cellxgene",
@@ -101,6 +101,7 @@
"clean-webpack-plugin": "^4.0.0-alpha.0",
"codecov": "^3.7.1",
"css-loader": "^5.2.4",
"css-minimizer-webpack-plugin": "^4.0.0",
"eslint": "^7.24.0",
"eslint-config-airbnb": "^18.2.0",
"eslint-config-prettier": "^8.2.0",
@@ -114,8 +115,6 @@
"eslint-plugin-react-hooks": "^4.0.8",
"expect-puppeteer": "^5.0.0",
"express": "^4.17.1",
"favicons": "^6.2.2",
"favicons-webpack-plugin": "^5.0.2",
"file-loader": "^6.0.0",
"html-webpack-plugin": "^5.3.1",
"husky": "^7.0.2",
@@ -134,11 +133,9 @@
"lodash.zip": "^4.2.0",
"mini-css-extract-plugin": "^1.5.0",
"obsolete-webpack-plugin": "^0.5.6",
"optimize-css-assets-webpack-plugin": "^5.0.3",
"prettier": "^2.0.5",
"puppeteer": "^8.0.0",
"rimraf": "^3.0.2",
"script-ext-html-webpack-plugin": "^2.1.4",
"serve-favicon": "^2.5.0",
"terser-webpack-plugin": "^5.1.1",
"webpack": "^5.34.0",
+4 -3
View File
@@ -58,10 +58,11 @@ function _maskToList(mask) {
if (!mask) {
return null;
}
const list = new Int32Array(mask.length);
const [...m] = mask;
const list = new Int32Array(m.length);
let elems = 0;
for (let i = 0, l = mask.length; i < l; i += 1) {
if (mask[i]) {
for (let i = 0, l = m.length; i < l; i += 1) {
if (m[i]) {
list[elems] = i;
elems += 1;
}
+5 -8
View File
@@ -91,12 +91,9 @@ export function _whereCacheCreate(field, query, columnLabels) {
*/
if (typeof query !== "object") return null;
if (query.where) {
const {
field: queryField,
column: queryColumn,
value: queryValue,
} = query.where;
const { where, summarize } = query;
if (where) {
const { field: queryField, column: queryColumn, value: queryValue } = where;
return {
where: {
[field]: {
@@ -107,13 +104,13 @@ export function _whereCacheCreate(field, query, columnLabels) {
},
};
}
if (query.summarize) {
if (summarize) {
const {
method,
field: queryField,
column: queryColumn,
values: queryValues,
} = query.summarize;
} = summarize;
const queryValueHash = _hashStringValues(queryValues);
return {
summarize: {
@@ -137,10 +137,13 @@ function _getEmbeddingRowOffsets(baseRowIndex, embeddingDf) {
- if the embedding contains NaN coordinates, return a rowIndex
that contains only the rows with discrete valued coordinates.
Currently assumes that there will be onl two dimensions in the embedding.
Currently assumes that there will be only two dimensions in the embedding.
*/
// eslint-disable-next-line react/destructuring-assignment -- destructuring fails
const X = embeddingDf.icol(0).asArray();
// eslint-disable-next-line react/destructuring-assignment -- destructuring fails
const Y = embeddingDf.icol(1).asArray();
const offsets = new Int32Array(X.length);
let numOffsets = 0;
+16
View File
@@ -0,0 +1,16 @@
#!/usr/bin/expect -f
# Mac only! (depends upon `open` command)
set h5ad [lindex $argv 0]
puts "$h5ad"
spawn cellxgene launch $h5ad
set timeout 10
expect -indices -re "Please go to (http:\/\/localhost:\[0-9\]+)" {
set url $expect_out(1,string)
exec >@stdout 2>@stderr open $url
}
interact
+1 -1
View File
@@ -2,7 +2,7 @@ import logging
import sys
from server.common.utils.utils import import_plugins
__version__ = "1.0.0"
__version__ = "1.0.1"
display_version = "cellxgene v" + __version__
try:
View File
+5
View File
@@ -0,0 +1,5 @@
from enum import Enum
class AnnotationType(Enum):
CELL_TYPE = "cell_type"
+231
View File
@@ -0,0 +1,231 @@
import functools
import json
import os.path
import shlex
import shutil
import subprocess
import sys
from subprocess import STDOUT, PIPE
from tempfile import NamedTemporaryFile
import click
import pandas as pd
from click import BadParameter
from server.annotate.annotation_types import AnnotationType
from server.common.utils.data_locator import DataLocator
from server.common.utils.utils import sort_options
def annotate_args(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
return func(*args, **kwargs)
return wrapper
@sort_options
@click.command(
short_help="Annotate H5AD file columns. Run `cellxgene annotation --help` for more information.",
options_metavar="<options>",
)
@click.option(
"-i",
"--input-h5ad-file",
required=True,
type=str,
help="The input H5AD file containing the missing annotations.",
)
@click.option(
"-m",
"--model-url",
required=True,
help="The URL of the model used to prediction annotated labels. May be a local filesystem directory "
"or S3 path (s3://)",
)
@click.option(
"-l",
"--counts-layer",
help="If specified, raw counts will be read from the AnnData layer of the specified name. If unspecified, "
"raw counts will be read from `X` matrix, unless 'raw.X' exists, in which case that will be used.",
)
@click.option(
"-g",
"--gene-column-name",
help="The name of the `var` column that contains gene identifiers. The values in this column will be used to match "
"genes between the query and reference datasets. If not specified, the gene identifiers are expected to exist "
"in `var.index`.",
)
# TODO: Useful if we want to support discoverability of models
# @click.option(
# "-r",
# "--model-repository",
# help="The base URL of the model repository. Maybe a local filesystem directory or S3 path (s3://)"
# )
# TODO: Useful if we want to support other, future annotation types, beyond "Cell Type". Currently hidden
@click.option(
"-a",
"--annotation-type",
type=click.Choice([t.value for t in AnnotationType]),
default=AnnotationType.CELL_TYPE.value,
show_default=True,
hidden=True, # Remove if we add support for more annotation types
help="The type of annotation to perform. This model to be used will be inferred from the annotation type.",
)
@click.option(
"-c",
"--annotation-prefix",
type=str,
default="cxg",
show_default=True,
help="An optional prefix used to form the names of: 1) new `obs` annotation columns that will store the predicted "
"annotation values and confidence scores, 2) `obsm` embeddings (reference and umap embedding), and "
"3) `uns` metadata for the prediction operation",
)
@click.option(
"-n",
"--run-name",
type=str,
help="An optional run name that will be used as a suffix to form the names of new `obs` annotation columns that "
"will store the predicted annotation values and confidence scores. This can be used to allow multiple "
"annotation predictions to be run on a single AnnData object.",
)
@click.option(
"-u",
"--update-h5ad-file",
is_flag=True,
help="Flag indicating whether to update the input h5ad file with annotation values. This option is mutually "
"exclusive with --output-h5ad-file.",
)
@click.option(
"-o",
"--output-h5ad-file",
help="The output H5AD file that will contain the generated annotation values. This option is mutually "
"exclusive with --update-h5ad-file.",
)
@click.option("--use-model-cache/--no-use-model-cache", default=True)
@click.option(
"--use-gpu/--no-use-gpu",
default=True,
help="Whether to use a GPU for annotation operations (highly recommended, if available).",
)
# TODO: This is a cell type model-specific arg, so not ideal to specify here as a hardcoded option
@click.option(
"--classifier",
default="default",
help="For cell type annotation, the classifier level to use. The classifier is model-dependent, so refer to "
"documentation for the specified model for valid values.",
)
# TODO: This is a cell type model-specific arg, so not ideal to specify here as a hardcoded option
@click.option(
"--organism",
type=click.Choice(["Homo sapiens", "Mus musculus"], case_sensitive=True),
default="Homo sapiens",
help="For cell type annotation, the organism of the dataset. Used to normalize gene names to HGLC conventions when "
"an annotation model has been trained using data from different organism.",
)
@click.option(
"--model-cache-dir",
default=".models_cache",
help="Local directory used to store model files that are retrieved from a remote location. Model files will "
"be read from this directory first, if they exist, to avoid repeating large downloads.",
)
@click.option(
"--mlflow-env-manager",
type=click.Choice(["virtualenv", "conda", "local"]),
default="virtualenv",
help="Annotation model prediction will be installed and executed in the specified type of environment. MacOS users "
"on Apple Silicon (arm64, M1, M2, etc.) are recommended to use 'conda' to avoid Python package installation "
"errors. If 'conda' is specified then cellxgene must also have been installed within a conda environment",
)
@click.help_option("--help", "-h", help="Show this message and exit.")
def annotate(**cli_args):
_validate_options(cli_args)
print(f"Reading query dataset {cli_args['input_h5ad_file']}...")
annotation_prefix = "_".join(
filter(None, [cli_args.get("annotation_prefix"), cli_args.get("annotation_type"), cli_args.get("run_name")])
)
output_h5ad_file = cli_args["input_h5ad_file"] if cli_args["update_h5ad_file"] else cli_args["output_h5ad_file"]
model_url = cli_args.get("model_url")
local_model_path = _retrieve_model(cli_args.get("model_cache_dir"), model_url, cli_args.get("use_model_cache"))
print(f"Annotating {cli_args.get('input_h5ad_file')} with {cli_args.get('annotation_type')}...")
if cli_args["annotation_type"] == AnnotationType.CELL_TYPE.value:
predict_args = dict(
query_dataset_h5ad_path=cli_args.get("input_h5ad_file"),
output_h5ad_path=output_h5ad_file,
annotation_prefix=annotation_prefix,
counts_layer=cli_args.get("counts_layer"),
gene_column_name=cli_args.get("gene_column_name"),
classifier=cli_args.get("classifier"),
organism=cli_args.get("organism"),
use_gpu=cli_args.get("use_gpu"),
)
# Drop args that have values of `None` as these will cause problems when passing into MLflow predict, since it
# ultimately gets converted into 1-row Pandas DataFrame (None is interpreted as a float type column!)
predict_args = dict([(k, v) for k, v in predict_args.items() if v is not None])
# Invoke prediction using MLflow cli, as a separate process.
# This fully prepares the Python environment that is needed for executing the model.
# The Python environment will be reused after it is setup once.
with NamedTemporaryFile(buffering=0) as predict_args_file:
# write the mlflow predict arguments to a csv file, which will be passed to mlflow cmd
pd.DataFrame([json.dumps(predict_args)]).to_csv(predict_args_file, index=None)
predict_args_file.seek(0)
# run mlflow prediction in subprocess
predict_cmd = (
f"mlflow models predict "
f"--env-manager {cli_args['mlflow_env_manager']} "
f"--model-uri {local_model_path} "
f"--content-type csv --input-path {predict_args_file.name}"
)
p = subprocess.Popen(
args=shlex.split(predict_cmd), stdin=predict_args_file, text=True, bufsize=0, stdout=PIPE, stderr=STDOUT
)
# display mlflow process output as it runs
for line in p.stdout:
print(line.rstrip())
p.wait()
if p.returncode == 0:
print(f"Wrote annotations to {cli_args.get('output_h5ad_file')}")
else:
print("Annotation failed!")
else:
raise BadParameter(f"unknown annotation type {cli_args['annotation_type']}")
def _retrieve_model(model_cache_dir, model_url, use_cache=True):
local_cache_model_path = os.path.join(model_cache_dir, os.path.splitext(os.path.basename(model_url))[0])
if not os.path.exists(local_cache_model_path) or not use_cache:
print(f"Retrieving model from {model_url}")
# download from remote source
with DataLocator(model_url).local_handle() as model_archive_local_path:
# unpack archive to local cache dir
shutil.unpack_archive(model_archive_local_path, local_cache_model_path)
else:
print(f"Using cached model at {local_cache_model_path}")
return local_cache_model_path
def _validate_options(cli_args):
# TODO(atolopko): Use cloup library for this logic
if cli_args["update_h5ad_file"] and cli_args["output_h5ad_file"]:
click.echo("--update_h5ad_file and --output_h5ad_file are mutually exclusive")
sys.exit(1)
if not (cli_args["update_h5ad_file"] or cli_args["output_h5ad_file"]):
click.echo("--update_h5ad_file or --output_h5ad_file must be specified")
sys.exit(1)
if __name__ == "__main__":
annotate()
+2
View File
@@ -1,5 +1,6 @@
import click
from .annotate import annotate
from .launch import launch
from .prepare import prepare
from .upgrade import log_upgrade_check
@@ -31,4 +32,5 @@ def cli(upgrade_check):
cli.add_command(launch)
cli.add_command(annotate)
cli.add_command(prepare)
+1 -1
View File
@@ -57,7 +57,7 @@ class Annotations(metaclass=ABCMeta):
pass
@abstractmethod
def write_gene_sets(self, gs, data_adaptor):
def write_gene_sets(self, gs, tid, data_adaptor):
"""Write the gene sets (gs) to a persistent storage such that it can later be read"""
pass
+67 -52
View File
@@ -7,6 +7,7 @@ from hashlib import blake2b
import pandas as pd
from flask import session
from fsspec import AbstractFileSystem
from server import __version__ as cellxgene_version
from server.app.session import get_user_id
@@ -62,21 +63,27 @@ class AnnotationsLocalFile(Annotations):
self.check_user_annotations_enabled() # raises
fname = self._get_celllabels_filename(data_adaptor)
empty_labels = pd.DataFrame()
if fname is None:
return empty_labels
with self.label_lock:
if fname is not None and os.path.exists(fname) and os.path.getsize(fname) > 0:
# returned the cached labels if possible, otherwise read them from the file
if fname == self.last_label_fname:
return self.last_labels
else:
labels = pd.read_csv(
fname, dtype="category", index_col=0, header=0, comment="#", keep_default_na=False
)
# update the cache
self.last_label_fname = fname
self.last_labels = labels
return labels
else:
return pd.DataFrame()
locator = DataLocator(fname)
if not locator.exists() or locator.size() == 0:
return empty_labels
# return the cached labels if possible
if fname == self.last_label_fname:
return self.last_labels
# otherwise, read labels from file
with locator.open() as f:
labels = pd.read_csv(f, dtype="category", index_col=0, header=0, comment="#", keep_default_na=False)
# update the cache
self.last_label_fname = fname
self.last_labels = labels
return labels
def write_labels(self, df, data_adaptor):
self.check_user_annotations_enabled() # raises
@@ -95,13 +102,12 @@ class AnnotationsLocalFile(Annotations):
fname = self._get_celllabels_filename(data_adaptor)
self._backup(fname)
if not df.empty:
with open(fname, "w", newline="") as f:
locator = DataLocator(fname)
with locator.open("w") as f:
if not df.empty:
if header is not None:
f.write(header)
df.to_csv(f)
else:
open(fname, "w").close()
# update the cache
self.last_label_fname = fname
@@ -109,26 +115,32 @@ class AnnotationsLocalFile(Annotations):
def read_gene_sets(self, data_adaptor, context=None):
fname = self._get_genesets_filename(data_adaptor)
gene_sets = {}
tid = None
empty_gene_sets = {}
with self.gene_sets_lock:
tid = self.last_geneset_tid # inside the critical section
if fname is not None and os.path.exists(fname) and os.path.getsize(fname) > 0:
# return the cached genesets if possible, otherwise read from file and validate them
if fname == self.last_geneset_fname:
gene_sets = self.last_geneset
else:
# read
gene_sets = read_gene_sets_tidycsv(DataLocator(fname), context)
if fname is None:
return (empty_gene_sets, tid)
# validate
gene_sets = data_adaptor.check_new_gene_sets(gene_sets, context)
locator = DataLocator(fname)
if not locator.exists() or locator.size() == 0:
return (empty_gene_sets, tid)
# update cache
self.last_geneset_fname = fname
self.last_geneset = gene_sets
# return the cached genesets if possible, otherwise read from file and validate them
if fname == self.last_geneset_fname:
return (self.last_geneset, tid)
return (gene_sets, tid)
# read
gene_sets = read_gene_sets_tidycsv(locator, context)
# validate
gene_sets = data_adaptor.check_new_gene_sets(gene_sets, context)
# update cache
self.last_geneset_fname = fname
self.last_geneset = gene_sets
return (gene_sets, tid)
def write_gene_sets(self, gene_sets, tid, data_adaptor):
self.check_gene_sets_save_enabled() # raises
@@ -157,9 +169,9 @@ class AnnotationsLocalFile(Annotations):
fname = self._get_genesets_filename(data_adaptor)
self._backup(fname)
with open(fname, "w", newline="") as f:
f.write(header)
f.write(self.gene_sets_to_csv(gene_sets))
locator = DataLocator(fname)
with locator.open("w", newline="") as f:
f.write(header + self.gene_sets_to_csv(gene_sets))
# update the cache
self.last_geneset_fname = fname
@@ -181,7 +193,7 @@ class AnnotationsLocalFile(Annotations):
output_file = self.label_output_file or self.gene_sets_output_file
if output_file:
return os.path.dirname(os.path.abspath(output_file))
return os.path.dirname(DataLocator(output_file).abspath())
return os.getcwd()
@@ -220,34 +232,37 @@ class AnnotationsLocalFile(Annotations):
1. fname -> backup_dir/fname-TIME
2. delete excess files in backup_dir
"""
root, ext = os.path.splitext(fname)
backup_dir = f"{root}-backups"
locator = DataLocator(fname)
fs: AbstractFileSystem = locator.fs # Handle to underlying fsspec file system
# Make sure there is work to do
if not os.path.exists(fname):
if not locator.exists():
return
root, ext = os.path.splitext(locator.abspath())
backup_dir = f"{root}-backups"
# Ensure backup_dir exists
if not os.path.exists(backup_dir):
os.mkdir(backup_dir)
fs.mkdirs(backup_dir, exist_ok=True)
# Save current file to backup_dir
fname_base = os.path.basename(fname)
fname_base_root, fname_base_ext = os.path.splitext(fname_base)
# don't use ISO standard time format, as it contains characters illegal on some filesytems.
# don't use ISO standard time format, as it contains characters illegal on some filesystems.
nowish = datetime.now().strftime("%Y-%m-%dT%H-%M-%S")
backup_fname = os.path.join(backup_dir, f"{fname_base_root}-{nowish}{fname_base_ext}")
if os.path.exists(backup_fname):
os.remove(backup_fname)
os.rename(fname, backup_fname)
if fs.exists(backup_fname):
fs.delete(backup_fname)
fs.rename(fname, backup_fname)
# prune the backup_dir to max number of backup files, keeping the most recent backups
backups = list(filter(lambda s: s.startswith(fname_base_root), os.listdir(backup_dir)))
excess_count = len(backups) - max_backups
if excess_count > 0:
backups.sort()
for bu in backups[0:excess_count]:
os.remove(os.path.join(backup_dir, bu))
backup_path_prefix = DataLocator.strip_protocol(os.path.join(backup_dir, fname_base_root + "-"))
backups = list(filter(lambda s: s.startswith(backup_path_prefix), fs.ls(backup_dir)))
# sorting to drop the oldest
excess_backups = list(sorted(backups, reverse=True))[max_backups:]
for bu in excess_backups:
fs.delete(bu)
def update_parameters(self, parameters, data_adaptor):
params = {}
+10 -5
View File
@@ -4,6 +4,7 @@ from os.path import splitext, isdir
from server.common.annotations.local_file_csv import AnnotationsLocalFile
from server.common.config.base_config import BaseConfig
from server.common.errors import ConfigurationError, AnnotationsError
from server.common.utils.data_locator import DataLocator
from server.data_common.matrix_loader import MatrixDataLoader
@@ -127,11 +128,15 @@ class DatasetConfig(BaseConfig):
if lf_ext and lf_ext != ".csv":
raise ConfigurationError(f"genesets file type must be .csv: {genesets_filename}")
if dirname is not None and not isdir(dirname):
try:
os.mkdir(dirname)
except OSError:
raise ConfigurationError("Unable to create directory specified by --user-generated-data-dir")
if dirname is not None:
if not DataLocator(dirname).islocal():
# remote object stores only support objects but not directories, do nothing
pass
elif not isdir(dirname):
try:
os.mkdir(dirname)
except OSError:
raise ConfigurationError("Unable to create directory specified by --user-generated-data-dir")
anno_config = {
"user-annotations": self.user_annotations__enable,
+13 -8
View File
@@ -52,8 +52,10 @@ class DataLocator:
self.fs = fsspec.filesystem(self.protocol)
def __repr__(self):
return f"DataLocator(protocol={self.protocol}, cname={self.cname}, "
f"path={self.path}, uri_or_path={self.uri_or_path})"
return (
f"DataLocator(protocol={self.protocol}, cname={self.cname}, "
f"path={self.path}, uri_or_path={self.uri_or_path})"
)
@staticmethod
def _get_protocol_and_path(uri_or_path):
@@ -65,6 +67,10 @@ class DataLocator:
return protocol, path
return None, uri_or_path
@staticmethod
def strip_protocol(uri_or_path):
return DataLocator._get_protocol_and_path(uri_or_path)[1]
def exists(self):
return self.fs.exists(self.cname)
@@ -72,7 +78,7 @@ class DataLocator:
return self.fs.size(self.cname)
def lastmodtime(self):
""" return datetime object representing last modification time, or None if unavailable """
"""return datetime object representing last modification time, or None if unavailable"""
info = self.fs.info(self.cname)
if self.islocal() and info is not None:
return datetime.fromtimestamp(info["mtime"])
@@ -92,8 +98,8 @@ class DataLocator:
def isfile(self):
return self.fs.isfile(self.cname)
def open(self, *args):
return self.fs.open(self.uri_or_path, *args)
def open(self, *args, **kwargs):
return self.fs.open(self.uri_or_path, *args, **kwargs)
def islocal(self):
return self.protocol is None or self.protocol == "file"
@@ -107,10 +113,9 @@ class DataLocator:
# do our best to create a file with the same.
ext = os.path.splitext(self.path)
suffix = None if ext[1] == "" else ext[1]
with self.open() as src, tempfile.NamedTemporaryFile(prefix="cellxgene_", suffix=suffix, delete=False) as tmp:
tmp.write(src.read())
with tempfile.NamedTemporaryFile(prefix="cellxgene_", suffix=suffix, delete=False) as tmp:
self.fs.download(self.uri_or_path, tmp.name)
tmp.close()
src.close()
tmp_path = tmp.name
return LocalFilePath(tmp_path, delete=True)
+14 -2
View File
@@ -174,10 +174,14 @@ class AnndataAdaptor(DataAdaptor):
except MemoryError:
raise DatasetAccessError("Out of memory - file is too large for available memory.")
except Exception:
raise DatasetAccessError(
import traceback
message = (
"File not found or is inaccessible. File must be an .h5ad object. "
"Please check your input and try again."
)
)
if self.server_config.app__verbose:
message += f"\n{traceback.format_exc()}"
raise DatasetAccessError(message)
def _validate_and_initialize(self):
if anndata_version_is_pre_070():
@@ -236,6 +240,14 @@ class AnndataAdaptor(DataAdaptor):
warnings.warn(
f"Anndata data matrix is in {self.data.X.dtype} format not float32. " f"Precision may be truncated."
)
if self.data.X.dtype < np.float32:
if self.data.isbacked:
raise DatasetAccessError(f"Data matrix in {self.data.X.dtype} format is not supported in backed mode."
" Please reload without --backed, or convert matrix to float32")
warnings.warn(
f"Anndata data matrix is in unsupported {self.data.X.dtype} format -- will be cast to float32"
)
self.data.X = self.data.X.astype(np.float32)
for ax in Axis:
curr_axis = getattr(self.data, str(ax))
for ann in curr_axis:
+2
View File
@@ -0,0 +1,2 @@
mlflow
scanpy
+1 -1
View File
@@ -2,9 +2,9 @@ black
bumpversion>=0.5
codecov>=2.0.15
parameterized>=0.7.0
psycopg2-binary>=2.8.5
pytest>=3.6.3
python-jose>=3.2.0
twine>=1.12.1
-r requirements.txt
-r requirements-prepare.txt
-r requirements-annotate.txt
+1 -1
View File
@@ -15,7 +15,7 @@ fsspec>=0.4.4,<0.8.0
gunicorn>=20.0.4
h5py>=3.0.0
numba>=0.51.2
numpy>=1.17.5
numpy>=1.17.5,<=1.22
packaging>=20.0
pandas>=1.0,!=1.1 # pandas 1.1 breaks tests, https://github.com/pandas-dev/pandas/issues/35446
PyYAML>=5.4 # CVE-2020-14343
+5 -2
View File
@@ -9,9 +9,12 @@ with open("server/requirements.txt") as fh:
with open("server/requirements-prepare.txt") as fh:
requirements_prepare = fh.read().splitlines()
with open("server/requirements-annotate.txt") as fh:
requirements_annotate = fh.read().splitlines()
setup(
name="cellxgene",
version="1.0.0",
version="1.0.1",
packages=find_packages(),
url="https://github.com/chanzuckerberg/cellxgene",
license="MIT",
@@ -40,5 +43,5 @@ setup(
"Topic :: Scientific/Engineering :: Bio-Informatics",
],
entry_points={"console_scripts": ["cellxgene = server.cli.cli:cli"]},
extras_require=dict(prepare=requirements_prepare),
extras_require=dict(prepare=requirements_prepare, annotate=requirements_annotate),
)
BIN
View File
Binary file not shown.
+5
View File
@@ -0,0 +1,5 @@
from .mlflow_model_fixture import FakeModel
def _load_pyfunc(data_path):
return FakeModel()
@@ -0,0 +1,11 @@
import mlflow
class FakeModel(mlflow.pyfunc.PythonModel):
def __init__(self, input_to_output: dict = {}):
self.input_to_output = input_to_output
def predict(self, model_input) -> None:
# this stdout output is useful for validating the input in a test, noting that this model will be invoked in a
# subprocess, so stdout is one means of communicating information back to the test code
print(f"__MODEL_INPUT__={model_input.iloc[0][0]}")
+111
View File
@@ -0,0 +1,111 @@
import os
import shutil
import unittest
from tempfile import mkstemp, TemporaryDirectory
import mlflow
from click.testing import CliRunner
from server.cli.annotate import annotate
from test.unit.cli.fixtures.mlflow_model_fixture import FakeModel
def write_model(model) -> str:
with TemporaryDirectory() as mlflow_model_dir:
fixtures_path = os.path.join(os.path.dirname(__file__), 'fixtures')
mlflow.pyfunc.save_model(mlflow_model_dir,
loader_module='fixtures',
code_path=[fixtures_path])
return shutil.make_archive(mkstemp()[1], "zip", mlflow_model_dir)
class TestCliAnnotate(unittest.TestCase):
def test__annotate__loads_and_runs(self):
"""
Invokes the `annotate` subcommand of cellxgene CLI, using a CliRunner() programmatic invocation.
This tests the happy path case:
1) Command line options are parsed;
2) An MLflow model zip archive can be read in (from local disk), unpacked, and invoked;
3) The correct options are passed to the MLflow model.
4) The annotate subcommand exits successfully.
This does not verify model output or predictions (it's a fake MLflow model, after all); it's up to the real model
to output its predictions as it wants, but this is specific to the model and so not tested here.
The CliRunner() invokes the subcommand in a subprocess, and the annotate subcommand itself invokes the MLflow
model in yet another subprocess. So while this test can help determine if everything is working, it is not a
simple matter to debug in the case of a failure. However, the stdout/stderr of the MLflow process is captured
by the CliRunner() subprocess, so errors can be inspected in result.stdout when debugging this test. Hope this
helps!
"""
_, query_dataset_file_path = mkstemp()
model_file_path = write_model(FakeModel())
result = CliRunner().invoke(
annotate,
[
"--input-h5ad-file",
query_dataset_file_path,
"--model-url",
model_file_path,
"--output-h5ad-file",
f"{query_dataset_file_path}.output",
# avoid having mflow create conda env or virtualenv when in test env;
# this avoids making pip remote requests and is also faster
"--mlflow-env-manager", "local"
],
)
# to help debugging, show the output from the CliRunner and MLflow stdout
if result.exit_code:
print(result.stdout)
self.assertEqual(0, result.exit_code, "runs successfully")
# The FakeModel will print it inputs to stdout, as "__MODEL_INPUT__={...}", allowing us to assert that it received valid inputs.
self.assertIn(
"__MODEL_INPUT__={"
f'"query_dataset_h5ad_path": "{query_dataset_file_path}", '
f'"output_h5ad_path": "{query_dataset_file_path}.output", '
'"annotation_prefix": "cxg_cell_type", "classifier": "default", '
'"organism": "Homo sapiens", "use_gpu": true}',
result.stdout,
"inputs passed correctly",
)
def test__annotate__verifies_mutually_exclusive_options(self):
required_options = ["--input-h5ad-file", "some.h5ad", "--model-url", "some_url"]
result = CliRunner().invoke(
annotate,
required_options + [],
)
self.assertNotEqual(0, result.exit_code, "aborts with non-success code")
self.assertIn(
"--update_h5ad_file or --output_h5ad_file must be specified",
result.stdout,
"error message displayed",
)
result = CliRunner().invoke(
annotate, required_options + ["--output-h5ad-file", "some_arg", "--update-h5ad-file"]
)
self.assertNotEqual(0, result.exit_code, "aborts with non-success code")
self.assertIn(
"--update_h5ad_file and --output_h5ad_file are mutually exclusive",
result.stdout,
"error message displayed",
)
# TODO:
# Test annotate cli args more comprehensively
# Test server.cli.annotate._validate_options
# Test model caching feature works
# Test model loading from s3 works (maybe w/just a real model)
if __name__ == "__main__":
unittest.main()
+1
View File
@@ -290,6 +290,7 @@ class EndPoints(object):
result_data = result.json()
self.assertEqual(result_data, pbmc3k_colors)
@unittest.skip('needs fix: https://github.com/chanzuckerberg/cellxgene/issues/2542')
def test_static(self):
endpoint = "static"
file = "assets/favicon.ico"
@@ -1,5 +1,4 @@
import json
import sys
import time
import unittest
@@ -37,6 +36,7 @@ Test the anndata adaptor using the pbmc3k data set.
(f"{FIXTURES_ROOT}/pbmc3k-CSC-gz.h5ad", True, "normal"),
(f"{FIXTURES_ROOT}/pbmc3k-CSR-gz.h5ad", True, "normal"),
(f"{FIXTURES_ROOT}/pbmc3k_64.h5ad", False, "auto"), # 64 bit conversion tests
(f"{FIXTURES_ROOT}/pbmc3k_16.h5ad", False, "auto"), # 16 bit conversion tests
],
)
class AdaptorTest(unittest.TestCase):
@@ -0,0 +1,23 @@
import unittest
from parameterized import parameterized_class
from server.common.errors import DatasetAccessError
from test import FIXTURES_ROOT
from test.unit import app_config
@parameterized_class(
("data_locator", "backed", "X_approximate_distribution"),
[
(f"{FIXTURES_ROOT}/pbmc3k_16.h5ad", True, "auto"), # 16 bit conversion tests
],
)
class AdaptorLoadErrorTest(unittest.TestCase):
def test_float16_backed_raises_err(self):
with self.assertRaises(DatasetAccessError):
config = app_config(
self.data_locator,
backed=self.backed,
extra_dataset_config=dict(X_approximate_distribution=self.X_approximate_distribution),
)