Skip to content

Commit 6ae79e9

Browse files
author
shuang
committed
update docs
1 parent 9c24de1 commit 6ae79e9

File tree

7 files changed

+14
-12
lines changed

7 files changed

+14
-12
lines changed

docs/en/source/api.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
.. autosummary::
99
:toctree: ./generated
1010
11-
gpt_celltype
12-
gpt_subtype
11+
get_celltype
12+
get_subtype
13+
check_celltype
1314
```

docs/en/source/models.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import gptbioinsightor as gbi
2222

2323
background = "Cells are PBMCs from a Healthy Donor"
2424

25-
res = gbi.gpt_celltype(adata, background=background, out="gbi.md", provider="openai", model="gpt-4o-mini")
25+
res = gbi.get_celltype(adata, background=background, out="gbi.md", provider="openai", model="gpt-4o-mini")
2626

2727
```
2828

@@ -41,7 +41,7 @@ import gptbioinsightor as gbi
4141

4242
background = "Cells are PBMCs from a Healthy Donor"
4343

44-
res = gbi.gpt_celltype(adata, background=background, out="gbi.md", provider="aliyun", model="qwen2-72b-instruct")
44+
res = gbi.get_celltype(adata, background=background, out="gbi.md", provider="aliyun", model="qwen2-72b-instruct")
4545

4646
```
4747

@@ -61,7 +61,7 @@ import gptbioinsightor as gbi
6161

6262
background = "Cells are PBMCs from a Healthy Donor"
6363

64-
res = gbi.gpt_celltype(adata, background=background, out="gbi.md", provider="moonshot", model="moonshot-v1-8k")
64+
res = gbi.get_celltype(adata, background=background, out="gbi.md", provider="moonshot", model="moonshot-v1-8k")
6565

6666
```
6767

@@ -83,6 +83,6 @@ BASE_URL = "https://api.flybirdsci.com/v1"
8383
8484
background = "Cells are PBMCs from a Healthy Donor"
8585
86-
res = gbi.gpt_celltype(adata, background=background, out="gbi.md", base_url=BASE_URL, model="gpt-4o")
86+
res = gbi.get_celltype(adata, background=background, out="gbi.md", base_url=BASE_URL, model="gpt-4o")
8787
8888
```

docs/en/source/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ background = "Cells are PBMCs from a Healthy Donor"
8888

8989
# here, I use Aliyun qwen2-72b-instruct
9090
# you can set openai gpt-4o
91-
res = gbi.gpt_celltype(adata, background=background, out="gbi.qwen.celltype.md", key="logreg_deg", topgenes=15,provider="aliyun", model="qwen2-72b-instruct")
91+
res = gbi.get_celltype(adata, background=background, out="gbi.qwen.celltype.md", key="logreg_deg", topgenes=15,provider="aliyun", model="qwen2-72b-instruct")
9292
res
9393
# {'0': 'CD4+ T Helper Cells',
9494
# '1': 'B Cells',

docs/en/source/seurat_usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ background = "Cells are PBMCs from a Healthy Donor"
6868

6969
# here, I use Aliyun qwen2-72b-instruct
7070
# you can set openai gpt-4o
71-
res = gbi.gpt_celltype(result_dict, background=background, out="Seurat.qwen.celltype.md", topgenes=20, provider="aliyun", model="qwen2-72b-instruct")
71+
res = gbi.get_celltype(result_dict, background=background, out="Seurat.qwen.celltype.md", topgenes=20, provider="aliyun", model="qwen2-72b-instruct")
7272
res
7373
# {0: 'T lymphocytes (T cells)',
7474
# 1: 'Monocytes/Macrophages',

docs/zh_CN/source/api.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
.. autosummary::
99
:toctree: ./generated
1010
11-
gpt_celltype
12-
gpt_subtype
11+
get_celltype
12+
get_subtype
13+
check_celltype
1314
```

docs/zh_CN/source/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ background = "Cells are PBMCs from a Healthy Donor"
8787

8888
# 使用阿里的通义千问qwen2-72b-instruct
8989
# 也可以设置成openai 的模型
90-
res = gbi.gpt_celltype(adata, background=background, out="gbi.qwen.celltype.md", key="logreg_deg", topgenes=15,provider="aliyun", model="qwen2-72b-instruct")
90+
res = gbi.get_celltype(adata, background=background, out="gbi.qwen.celltype.md", key="logreg_deg", topgenes=15,provider="aliyun", model="qwen2-72b-instruct")
9191
res
9292
# {'0': 'CD4+ T Helper Cells',
9393
# '1': 'B Cells',

docs/zh_CN/source/seurat_usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ background = "Cells are PBMCs from a Healthy Donor"
6767

6868
# 使用阿里的通义千问qwen2-72b-instruct
6969
# 也可以设置成openai 的模型
70-
res = gbi.gpt_celltype(result_dict, background=background, out="Seurat.qwen.celltype.md", topgenes=20, provider="aliyun", model="qwen2-72b-instruct")
70+
res = gbi.get_celltype(result_dict, background=background, out="Seurat.qwen.celltype.md", topgenes=20, provider="aliyun", model="qwen2-72b-instruct")
7171
res
7272
# {0: 'T lymphocytes (T cells)',
7373
# 1: 'Monocytes/Macrophages',

0 commit comments

Comments
 (0)