:pencil: update docs (c4609d73) · Commits · 钟慕尧 / deepchem

deepchem/data/datasets.py

+18 −4

Original line number	Diff line number	Diff line
		@@ -512,6 +512,7 @@ class Dataset(object):

		Returns
		-------
		torch.utils.data.IterableDataset
		`torch.utils.data.IterableDataset` that iterates over the data in
		this dataset.
		"""
		@@ -864,6 +865,12 @@ class NumpyDataset(Dataset):
		deterministic: bool
		if True, the data is produced in order. If False, a different random
		permutation of the data is used for each epoch.

		Returns
		-------
		torch.utils.data.IterableDataset
		`torch.utils.data.IterableDataset` that iterates over the data in
		this dataset.
		"""
		try:
		from deepchem.data.pytorch_datasets import TorchNumpyDataset
		@@ -1457,6 +1464,12 @@ class DiskDataset(Dataset):
		deterministic: bool
		if True, the data is produced in order. If False, a different random
		permutation of the data is used for each epoch.

		Returns
		-------
		torch.utils.data.IterableDataset
		`torch.utils.data.IterableDataset` that iterates over the data in
		this dataset.
		"""
		try:
		from deepchem.data.pytorch_datasets import TorchDiskDataset
		@@ -2228,7 +2241,8 @@ class ImageDataset(Dataset):

		Returns
		-------
		`torch.utils.data.IterableDataset` iterating over the same data as
		torch.utils.data.IterableDataset
		`torch.utils.data.IterableDataset` that iterates over the data in
		this dataset.
		"""
		try:

+3 −3

Original line number	Diff line number	Diff line
		@@ -14,7 +14,7 @@ class TorchNumpyDataset(torch.utils.data.IterableDataset): # type: ignore
		Parameters
		----------
		numpy_dataset: NumpyDataset
		The original NumpyDataset which you want to convert to PyTorch
		The original NumpyDataset which you want to convert to PyTorch Dataset
		epochs: int
		the number of times to iterate over the Dataset
		deterministic: bool
		@@ -52,7 +52,7 @@ class TorchDiskDataset(torch.utils.data.IterableDataset): # type: ignore
		Parameters
		----------
		disk_dataset: DiskDataset
		The original DiskDataset which you want to convert to PyTorch
		The original DiskDataset which you want to convert to PyTorch Dataset
		epochs: int
		the number of times to iterate over the Dataset
		deterministic: bool
		@@ -91,7 +91,7 @@ class TorchImageDataset(torch.utils.data.IterableDataset): # type: ignore
		Parameters
		----------
		image_dataset: ImageDataset
		The original ImageDataset which you want to convert to PyTorch
		The original ImageDataset which you want to convert to PyTorch Dataset
		epochs: int
		the number of times to iterate over the Dataset
		deterministic: bool