Skip to content

Commit

Permalink
feat: tune docs (#948)
Browse files Browse the repository at this point in the history
Co-authored-by: xu rui <[email protected]>
  • Loading branch information
icecraft and xu rui authored Nov 13, 2024
1 parent 927fc6c commit 7d40115
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 1 deletion.
4 changes: 4 additions & 0 deletions next_docs/en/user_guide/data/data_reader_writer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ Read Examples

.. code:: python
from magic_pdf.data.data_reader_writer import *
# file based related
file_based_reader1 = FileBasedDataReader('')
Expand Down Expand Up @@ -142,6 +144,8 @@ Write Examples

.. code:: python
from magic_pdf.data.data_reader_writer import *
# file based related
file_based_writer1 = FileBasedDataWriter('')
Expand Down
7 changes: 6 additions & 1 deletion next_docs/en/user_guide/data/read_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Read the contet from jsonl which may located on local machine or remote s3. if y

.. code:: python
from magic_pdf.data.io.read_api import *
# read jsonl from local machine
datasets = read_jsonl("tt.jsonl", None)
Expand All @@ -33,6 +35,8 @@ Read pdf from path or directory.

.. code:: python
from magic_pdf.data.io.read_api import *
# read pdf path
datasets = read_local_pdfs("tt.pdf")
Expand All @@ -47,10 +51,11 @@ Read images from path or directory

.. code:: python
from magic_pdf.data.io.read_api import *
# read from image path
datasets = read_local_images("tt.png")
# read files from directory that endswith suffix in suffixes array
datasets = read_local_images("images/", suffixes=["png", "jpg"])
Expand Down
4 changes: 4 additions & 0 deletions next_docs/zh_cn/user_guide/data/data_reader_writer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ S3DataReader 基于 MultiBucketS3DataReader 构建,但仅支持单个桶。S3D
---------
.. code:: python
from magic_pdf.data.data_reader_writer import *
# 文件相关的
file_based_reader1 = FileBasedDataReader('')
Expand Down Expand Up @@ -126,6 +128,8 @@ S3DataReader 基于 MultiBucketS3DataReader 构建,但仅支持单个桶。S3D
----------
.. code:: python
from magic_pdf.data.data_reader_writer import *
# 文件相关的
file_based_writer1 = FileBasedDataWriter('')
Expand Down
6 changes: 6 additions & 0 deletions next_docs/zh_cn/user_guide/data/read_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ read_jsonl

.. code:: python
from magic_pdf.data.io.read_api import *
# 从本地机器读取 JSONL
datasets = read_jsonl("tt.jsonl", None)
Expand All @@ -28,6 +30,8 @@ read_local_pdfs

.. code:: python
from magic_pdf.data.io.read_api import *
# 读取 PDF 路径
datasets = read_local_pdfs("tt.pdf")
Expand All @@ -41,6 +45,8 @@ read_local_images

.. code:: python
from magic_pdf.data.io.read_api import *
# 从图像路径读取
datasets = read_local_images("tt.png")
Expand Down

0 comments on commit 7d40115

Please sign in to comment.