Missing video docs (#7251)

* missing video docs * mention experimental
huggingface · Oct 24, 2024 · 8413aac · 8413aac
1 parent 8235fdb
commit 8413aac
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/docs/source/package_reference/loading_methods.mdx b/docs/source/package_reference/loading_methods.mdx
@@ -85,6 +85,12 @@ load_dataset("csv", data_dir="path/to/data/dir", sep="\t")
 
 [[autodoc]] datasets.packaged_modules.audiofolder.AudioFolder
 
+### Videos
+
+[[autodoc]] datasets.packaged_modules.videofolder.VideoFolderConfig
+
+[[autodoc]] datasets.packaged_modules.videofolder.VideoFolder
+
 ### WebDataset
 
 [[autodoc]] datasets.packaged_modules.webdataset.WebDataset
diff --git a/src/datasets/features/video.py b/src/datasets/features/video.py
@@ -21,7 +21,8 @@
 
 @dataclass
 class Video:
-    """Video [`Feature`] to read video data from a video file.
+    """
+    **Experimental.** Video [`Feature`] to read video data from a video file.
 
     Input: The Video feature accepts as input:
     - A `str`: Absolute path to the video file (i.e. random access is allowed).
@@ -32,7 +33,6 @@ class Video:
 
       This is useful for archived files with sequential access.
 
-    - An `np.ndarray`: NumPy array representing a video.
     - A `decord.VideoReader`: decord video reader object.
 
     Args: