From 2d0b0ba5968dab5cd698d88b5201c1314b9c7f55 Mon Sep 17 00:00:00 2001 From: Gao Enhao Date: Wed, 13 Dec 2023 19:16:15 +0800 Subject: [PATCH] [DOC, MNT] resolve dataset relative comments --- docs/Intro/Datasets.rst | 2 +- docs/Intro/Quick-Start.rst | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/Intro/Datasets.rst b/docs/Intro/Datasets.rst index e50b32d..a2f9ab9 100644 --- a/docs/Intro/Datasets.rst +++ b/docs/Intro/Datasets.rst @@ -13,7 +13,7 @@ Dataset & Data Structure Dataset ------- -ABL-Package offers several `dataset classes <../API/abl.dataset.html>`_ for different usage, such as ``ClassificationDataset``, ``RegressionDataset`` and ``PredictionDataset``, while users are only required to organize the dataset into a tuple consists of the following three components +ABL-Package assumes user data to be structured as a tuple, comprising the following three components: - ``X``: List[List[Any]] A list of instances representing the input data. We refer to each List in ``X`` as an instance and one instance may contain several elements. diff --git a/docs/Intro/Quick-Start.rst b/docs/Intro/Quick-Start.rst index f8f2551..dcece43 100644 --- a/docs/Intro/Quick-Start.rst +++ b/docs/Intro/Quick-Start.rst @@ -68,8 +68,6 @@ Out: Shape of X [C, H, W]: torch.Size([1, 28, 28]) -ABL-Package provides several dataset classes for different purposes, including ``ClassificationDataset``, ``RegressionDataset``, and ``PredictionDataset``. However, it's not necessary to encapsulate data into these specific classes. Instead, we only need to structure our datasets in the aforementioned formats. - Read more about `preparing datasets `_. Building the Learning Part