From 7d40115cce0e79d5a1224d3e6585686678920a0a Mon Sep 17 00:00:00 2001 From: icecraft Date: Wed, 13 Nov 2024 20:07:18 +0800 Subject: [PATCH] feat: tune docs (#948) Co-authored-by: xu rui --- next_docs/en/user_guide/data/data_reader_writer.rst | 4 ++++ next_docs/en/user_guide/data/read_api.rst | 7 ++++++- next_docs/zh_cn/user_guide/data/data_reader_writer.rst | 4 ++++ next_docs/zh_cn/user_guide/data/read_api.rst | 6 ++++++ 4 files changed, 20 insertions(+), 1 deletion(-) diff --git a/next_docs/en/user_guide/data/data_reader_writer.rst b/next_docs/en/user_guide/data/data_reader_writer.rst index 132a4fff..501e320f 100644 --- a/next_docs/en/user_guide/data/data_reader_writer.rst +++ b/next_docs/en/user_guide/data/data_reader_writer.rst @@ -87,6 +87,8 @@ Read Examples .. code:: python + from magic_pdf.data.data_reader_writer import * + # file based related file_based_reader1 = FileBasedDataReader('') @@ -142,6 +144,8 @@ Write Examples .. code:: python + from magic_pdf.data.data_reader_writer import * + # file based related file_based_writer1 = FileBasedDataWriter('') diff --git a/next_docs/en/user_guide/data/read_api.rst b/next_docs/en/user_guide/data/read_api.rst index b4048245..f11b5039 100644 --- a/next_docs/en/user_guide/data/read_api.rst +++ b/next_docs/en/user_guide/data/read_api.rst @@ -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) @@ -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") @@ -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"]) diff --git a/next_docs/zh_cn/user_guide/data/data_reader_writer.rst b/next_docs/zh_cn/user_guide/data/data_reader_writer.rst index e43169e9..af244a5c 100644 --- a/next_docs/zh_cn/user_guide/data/data_reader_writer.rst +++ b/next_docs/zh_cn/user_guide/data/data_reader_writer.rst @@ -73,6 +73,8 @@ S3DataReader 基于 MultiBucketS3DataReader 构建，但仅支持单个桶。S3D --------- .. code:: python + from magic_pdf.data.data_reader_writer import * + # 文件相关的 file_based_reader1 = FileBasedDataReader('') @@ -126,6 +128,8 @@ S3DataReader 基于 MultiBucketS3DataReader 构建，但仅支持单个桶。S3D ---------- .. code:: python + from magic_pdf.data.data_reader_writer import * + # 文件相关的 file_based_writer1 = FileBasedDataWriter('') diff --git a/next_docs/zh_cn/user_guide/data/read_api.rst b/next_docs/zh_cn/user_guide/data/read_api.rst index aadfb21e..d040b2fe 100644 --- a/next_docs/zh_cn/user_guide/data/read_api.rst +++ b/next_docs/zh_cn/user_guide/data/read_api.rst @@ -15,6 +15,8 @@ read_jsonl .. code:: python + from magic_pdf.data.io.read_api import * + # 从本地机器读取 JSONL datasets = read_jsonl("tt.jsonl", None) @@ -28,6 +30,8 @@ read_local_pdfs .. code:: python + from magic_pdf.data.io.read_api import * + # 读取 PDF 路径 datasets = read_local_pdfs("tt.pdf") @@ -41,6 +45,8 @@ read_local_images .. code:: python + from magic_pdf.data.io.read_api import * + # 从图像路径读取 datasets = read_local_images("tt.png")