Skip to content

Commit 7280a08

Browse files
committed
update docs
1 parent 5a93b38 commit 7280a08

4 files changed

Lines changed: 91 additions & 8 deletions

File tree

docs/tutorials/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ We provide several tutorials to help you get started with Cell2Net and explore i
88

99
k562/index
1010
pbmc/index
11+
misc/index
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "code",
5+
"execution_count": null,
6+
"id": "f08e5563",
7+
"metadata": {},
8+
"outputs": [
9+
{
10+
"ename": "",
11+
"evalue": "",
12+
"output_type": "error",
13+
"traceback": [
14+
"\u001b[1;31mRunning cells with 'zl_cell2net (Python 3.12.13)' requires the ipykernel package.\n",
15+
"\u001b[1;31m<a href='command:jupyter.createPythonEnvAndSelectController'>Create a Python Environment</a> with the required packages.\n",
16+
"\u001b[1;31mOr install 'ipykernel' using the command: 'conda install -n zl_cell2net ipykernel --update-deps --force-reinstall'"
17+
]
18+
}
19+
],
20+
"source": [
21+
"import warnings\n",
22+
"warnings.filterwarnings(\"ignore\")\n",
23+
"\n",
24+
"import mudata as md\n",
25+
"import muon as mu\n",
26+
"import scanpy as sc\n",
27+
"\n",
28+
"md.set_options(pull_on_update=False)"
29+
]
30+
},
31+
{
32+
"cell_type": "markdown",
33+
"id": "0e27c8ff",
34+
"metadata": {},
35+
"source": [
36+
"# in this tutorial, we show how to create mudata from 10x multiome output file\n",
37+
"\n",
38+
"# data is downloaded from [here](https://www.10xgenomics.com/datasets/human-kidney-cancer-nuclei-isolated-with-chromium-nuclei-isolation-kit-saltyez-protocol-and-10x-complex-tissue-dp-ct-sorted-and-ct-unsorted-1-standard)"
39+
]
40+
},
41+
{
42+
"cell_type": "code",
43+
"execution_count": null,
44+
"id": "2caed670",
45+
"metadata": {},
46+
"outputs": [],
47+
"source": [
48+
"mu.read"
49+
]
50+
}
51+
],
52+
"metadata": {
53+
"kernelspec": {
54+
"display_name": "zl_cell2net",
55+
"language": "python",
56+
"name": "python3"
57+
},
58+
"language_info": {
59+
"codemirror_mode": {
60+
"name": "ipython",
61+
"version": 3
62+
},
63+
"file_extension": ".py",
64+
"mimetype": "text/x-python",
65+
"name": "python",
66+
"nbconvert_exporter": "python",
67+
"pygments_lexer": "ipython3",
68+
"version": "3.12.13"
69+
}
70+
},
71+
"nbformat": 4,
72+
"nbformat_minor": 5
73+
}

docs/tutorials/misc/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Miscellaneous
2+
=============================
3+
4+
Miscellaneous tutorials related to Cell2Net.
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
01_create_mudata

docs/tutorials/pbmc/01_pretrain.ipynb

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -566,7 +566,7 @@
566566
},
567567
{
568568
"cell_type": "code",
569-
"execution_count": 33,
569+
"execution_count": null,
570570
"id": "c47e999a",
571571
"metadata": {},
572572
"outputs": [
@@ -665,7 +665,7 @@
665665
}
666666
],
667667
"source": [
668-
"model.train(df_train=df_train, df_valid=df_valid, max_epochs=100, \n",
668+
"model.train(df_train=df_train, df_valid=df_valid, max_epochs=100,\n",
669669
" batch_size=512, weight_decay=1e-04, lr=3e-04)"
670670
]
671671
},
@@ -764,7 +764,7 @@
764764
},
765765
{
766766
"cell_type": "code",
767-
"execution_count": 37,
767+
"execution_count": null,
768768
"id": "77e2dc0a",
769769
"metadata": {},
770770
"outputs": [
@@ -798,7 +798,7 @@
798798
"# set axis-x and axis-y the same scale\n",
799799
"plt.xlim(_min, _max)\n",
800800
"plt.ylim(_min, _max)\n",
801-
"plt.title('pearsonR = {:.3f}'.format(pearsonR))\n",
801+
"plt.title(f'pearsonR = {pearsonR:.3f}')\n",
802802
"plt.xlabel('True Accessibility (log1p counts)')\n",
803803
"plt.ylabel('Predicted Accessibility (log1p counts)')\n",
804804
"plt.tight_layout()"
@@ -818,7 +818,7 @@
818818
},
819819
{
820820
"cell_type": "code",
821-
"execution_count": 38,
821+
"execution_count": null,
822822
"id": "6bb36af8",
823823
"metadata": {},
824824
"outputs": [
@@ -853,7 +853,7 @@
853853
"# set axis-x and axis-y the same scale\n",
854854
"plt.xlim(_min, _max)\n",
855855
"plt.ylim(_min, _max)\n",
856-
"plt.title('pearsonR = {:.3f}'.format(pearsonR))\n",
856+
"plt.title(f'pearsonR = {pearsonR:.3f}')\n",
857857
"plt.gca().set_aspect('equal', adjustable='box')\n",
858858
"plt.xlabel('True Accessibility (log1p counts)')\n",
859859
"plt.ylabel('Predicted Accessibility (log1p counts)')\n",
@@ -904,7 +904,7 @@
904904
],
905905
"metadata": {
906906
"kernelspec": {
907-
"display_name": "zl_cell2net",
907+
"display_name": "zl_src",
908908
"language": "python",
909909
"name": "python3"
910910
},
@@ -918,7 +918,7 @@
918918
"name": "python",
919919
"nbconvert_exporter": "python",
920920
"pygments_lexer": "ipython3",
921-
"version": "3.12.11"
921+
"version": "3.12.13"
922922
}
923923
},
924924
"nbformat": 4,

0 commit comments

Comments
 (0)