Skip to content

Commit 7c87403

Browse files
ZiyiXiaZiyiXia
committed
documentation
1 parent 5a04983 commit 7c87403

116 files changed

Lines changed: 9968 additions & 2 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,5 +143,4 @@ pic2.py
143143

144144
# results
145145
en_results
146-
zh_results
147-
docs
146+
zh_results

‎docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
install the required pkgs:
2+
```
3+
pip install -r requirements.txt
4+
```
5+
6+
7+
to host the webpages locally:
8+
```
9+
python -m http.server
10+
```

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/requirements.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx
2+
myst-nb
3+
furo

‎docs/source/API/abc.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Abstract Class
2+
==============
3+
4+
.. toctree::
5+
abc/inference
6+
abc/finetune

‎docs/source/API/abc/finetune.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Finetune
2+
========
3+
4+
.. toctree::
5+
finetune/embedder
6+
finetune/reranker

‎docs/source/API/abc/finetune/embedder.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Embedder
2+
========
3+
4+
.. toctree::
5+
embedder/AbsArguments
6+
embedder/AbsDataset
7+
embedder/AbsModeling
8+
embedder/AbsTrainer
9+
embedder/AbsRunner

‎docs/source/API/abc/finetune/embedder/AbsArguments.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
AbsArguments
2+
============
3+
4+
.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerModelArguments
5+
6+
.. autoclass:: FlagEmbedding.abc.finetune.reranker.AbsRerankerDataArguments

‎docs/source/API/abc/finetune/embedder/AbsDataset.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
==========
2+
AbsDataset
3+
==========
4+
5+
AbsEmbedderTrainDataset
6+
=======================
7+
8+
.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderTrainDataset
9+
10+
Methods
11+
-------
12+
13+
.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderTrainDataset._load_dataset
14+
15+
.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderTrainDataset._shuffle_text
16+
17+
AbsEmbedderCollator
18+
===================
19+
20+
.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderCollator
21+
22+
AbsEmbedderSameDatasetTrainDataset
23+
==================================
24+
25+
.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset
26+
27+
Methods
28+
-------
29+
30+
.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset.refresh_epoch
31+
32+
.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset._load_dataset
33+
34+
.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset._get_file_batch_size
35+
36+
.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset._get_train_group_size
37+
38+
.. automethod:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetTrainDataset._create_batch_data
39+
40+
AbsEmbedderSameDatasetCollator
41+
==============================
42+
43+
.. autoclass:: FlagEmbedding.abc.finetune.embedder.AbsEmbedderSameDatasetCollator
44+
45+
EmbedderTrainerCallbackForDataRefresh
46+
=====================================
47+
48+
.. autoclass:: FlagEmbedding.abc.finetune.embedder.EmbedderTrainerCallbackForDataRefresh
49+
50+
Methods
51+
-------
52+
53+
.. automethod:: FlagEmbedding.abc.finetune.embedder.EmbedderTrainerCallbackForDataRefresh.on_epoch_end

0 commit comments

Comments
 (0)