Santiago commited on
Commit
d7fbc3f
1 Parent(s): 315a6f9

Add some minimal documentation

Browse files
Files changed (1) hide show
  1. waxal-wolof.py +2 -15
waxal-wolof.py CHANGED
@@ -11,18 +11,14 @@
11
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
  # See the License for the specific language governing permissions and
13
  # limitations under the License.
14
- """TODO: Add a description here."""
15
 
16
 
17
  import csv
18
- import itertools
19
- import logging
20
  import os
21
 
22
  import datasets
23
 
24
- logger = logging.getLogger()
25
-
26
 
27
  # TODO: Add BibTeX citation
28
  # Find for instance the citation on arxiv or on the dataset repo/website
@@ -35,15 +31,9 @@ year={2020}
35
  }
36
  """
37
 
38
- # TODO: Add description of the dataset here
39
- # You can copy an official description
40
- _DESCRIPTION = """\
41
- """
42
-
43
  # TODO: Add a link to an official homepage for the dataset here
44
  _HOMEPAGE = ""
45
 
46
- # TODO: Add the licence for the dataset here if you can find it
47
  _LICENSE = "Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0)"
48
 
49
  _MODALITIES_COMBINATION = [
@@ -85,8 +75,6 @@ class WaxalConfig(datasets.BuilderConfig):
85
 
86
 
87
  class WaxalWolof(datasets.GeneratorBasedBuilder):
88
- """TODO: Short description of my dataset."""
89
-
90
  BUILDER_CONFIGS = [
91
  WaxalConfig(
92
  name="-".join(modalities),
@@ -114,7 +102,7 @@ class WaxalWolof(datasets.GeneratorBasedBuilder):
114
  features["text_annotation"] = datasets.Value("string")
115
 
116
  return datasets.DatasetInfo(
117
- description=_DESCRIPTION,
118
  features=datasets.Features(features),
119
  homepage=_HOMEPAGE,
120
  license=_LICENSE,
@@ -134,7 +122,6 @@ class WaxalWolof(datasets.GeneratorBasedBuilder):
134
  return "text" in self.config.modalities
135
 
136
  def _split_generators(self, dl_manager):
137
- logger.debug("splitting")
138
  audio_url_key = "transcribed-audio" if self.with_text else "audio-files"
139
  image_url_key = "captioned-images" if self.with_text else "image-files"
140
 
 
11
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
  # See the License for the specific language governing permissions and
13
  # limitations under the License.
14
+ """Waxal Wolof Dataset."""
15
 
16
 
17
  import csv
 
 
18
  import os
19
 
20
  import datasets
21
 
 
 
22
 
23
  # TODO: Add BibTeX citation
24
  # Find for instance the citation on arxiv or on the dataset repo/website
 
31
  }
32
  """
33
 
 
 
 
 
 
34
  # TODO: Add a link to an official homepage for the dataset here
35
  _HOMEPAGE = ""
36
 
 
37
  _LICENSE = "Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0)"
38
 
39
  _MODALITIES_COMBINATION = [
 
75
 
76
 
77
  class WaxalWolof(datasets.GeneratorBasedBuilder):
 
 
78
  BUILDER_CONFIGS = [
79
  WaxalConfig(
80
  name="-".join(modalities),
 
102
  features["text_annotation"] = datasets.Value("string")
103
 
104
  return datasets.DatasetInfo(
105
+ description=self.config.description,
106
  features=datasets.Features(features),
107
  homepage=_HOMEPAGE,
108
  license=_LICENSE,
 
122
  return "text" in self.config.modalities
123
 
124
  def _split_generators(self, dl_manager):
 
125
  audio_url_key = "transcribed-audio" if self.with_text else "audio-files"
126
  image_url_key = "captioned-images" if self.with_text else "image-files"
127