tanthinhdt commited on
Commit
20167cb
·
verified ·
1 Parent(s): 9b44b14

docs(builder): add docstring

Browse files
Files changed (1) hide show
  1. how2sign.py +29 -8
how2sign.py CHANGED
@@ -24,8 +24,12 @@ class How2SignConfig(datasets.BuilderConfig):
24
 
25
  def __init__(self, name, **kwargs):
26
  """
27
- :param name: Name of subset.
28
- :param kwargs: Arguments.
 
 
 
 
29
  """
30
  super(How2SignConfig, self).__init__(
31
  name=name,
@@ -70,8 +74,16 @@ class How2Sign(datasets.GeneratorBasedBuilder):
70
  ) -> list[datasets.SplitGenerator]:
71
  """
72
  Get splits.
73
- :param dl_manager: Download manager.
74
- :return: Splits.
 
 
 
 
 
 
 
 
75
  """
76
  split_dict = {
77
  "train": datasets.Split.TRAIN,
@@ -104,10 +116,19 @@ class How2Sign(datasets.GeneratorBasedBuilder):
104
  video_dirs: list[str],
105
  ) -> tuple[int, dict]:
106
  """
107
- Generate examples from metadata.
108
- :param metadata_path: Path to metadata.
109
- :param visual_dirs: Directories of videos.
110
- :yield: Example.
 
 
 
 
 
 
 
 
 
111
  """
112
  split = datasets.load_dataset(
113
  "csv",
 
24
 
25
  def __init__(self, name, **kwargs):
26
  """
27
+ Parameters
28
+ ----------
29
+ name : str
30
+ Name of subset.
31
+ kwargs : dict
32
+ Keyword arguments.
33
  """
34
  super(How2SignConfig, self).__init__(
35
  name=name,
 
74
  ) -> list[datasets.SplitGenerator]:
75
  """
76
  Get splits.
77
+
78
+ Parameters
79
+ ----------
80
+ dl_manager : datasets.DownloadManager
81
+ Download manager.
82
+
83
+ Returns
84
+ -------
85
+ list[datasets.SplitGenerator]
86
+ Split generators.
87
  """
88
  split_dict = {
89
  "train": datasets.Split.TRAIN,
 
116
  video_dirs: list[str],
117
  ) -> tuple[int, dict]:
118
  """
119
+ Generate examples.
120
+
121
+ Parameters
122
+ ----------
123
+ metadata_path : str
124
+ Path to metadata.
125
+ video_dirs : list[str]
126
+ List of video directories.
127
+
128
+ Returns
129
+ -------
130
+ tuple[int, dict]
131
+ Index and sample.
132
  """
133
  split = datasets.load_dataset(
134
  "csv",