Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mthrok
mthrok authored and ci committed Jul 28, 2024
0 parents commit 131924e
Show file tree
Hide file tree
Showing 298 changed files with 41,337 additions and 0 deletions.
2 changes: 2 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include:
- _static
11 changes: 11 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html>
<head>
<title>SPDL</title>
</head>
<body>
<p>Redirecting to the main document.</p>
<script>
window.location.href= "./main/index.html";
</script>
</html>
4 changes: 4 additions & 0 deletions main/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 8aa5a445c937711ffc8fad28f3a59517
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added main/.doctrees/api.doctree
Binary file not shown.
Binary file added main/.doctrees/environment.pickle
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.dataloader.Pipeline.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.dataloader.PipelineBuilder.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.dataloader.PipelineFailure.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.dataloader.PipelineHook.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.dataloader.TaskStatsHook.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.dataloader.create_task.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.dataloader.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.AudioFrames.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.AudioPackets.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.CPUBuffer.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.CUDABuffer.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.CUDAConfig.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.DecodeConfig.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.DemuxConfig.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.Demuxer.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.EncodeConfig.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.Frames.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.ImageFrames.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.ImagePackets.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.Packets.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.VideoFrames.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.VideoPackets.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_convert_frames.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_decode_image_nvjpeg.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_decode_packets.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_decode_packets_nvdec.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_demux_audio.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_demux_image.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_demux_video.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_encode_image.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_load_audio.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_load_image.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_load_image_batch.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_load_image_batch_nvdec.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_load_image_batch_nvjpeg.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_load_video.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_sample_decode_video.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_streaming_decode_packets.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_transfer_buffer.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.async_transfer_buffer_cpu.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.convert_frames.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.cuda_config.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.decode_config.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.decode_image_nvjpeg.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.decode_packets.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.decode_packets_nvdec.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.demux_audio.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.demux_config.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.demux_image.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.demux_video.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.encode_config.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.encode_image.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.get_audio_filter_desc.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.get_filter_desc.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.get_video_filter_desc.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.load_audio.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.load_image.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.load_image_batch_nvjpeg.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.load_video.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.run_async.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.streaming_decode_packets.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.to_numba.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.to_numpy.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.to_torch.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.transfer_buffer.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.io.transfer_buffer_cpu.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.utils.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.utils.get_ffmpeg_filters.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.utils.get_ffmpeg_log_level.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.utils.is_cuda_available.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.utils.is_nvcodec_available.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.utils.set_ffmpeg_log_level.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.utils.trace_counter.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.utils.trace_event.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.utils.trace_gc.doctree
Binary file not shown.
Binary file added main/.doctrees/generated/spdl.utils.tracing.doctree
Binary file not shown.
Binary file added main/.doctrees/getting_started/concurrency.doctree
Binary file not shown.
Binary file added main/.doctrees/getting_started/index.doctree
Binary file not shown.
Binary file added main/.doctrees/getting_started/intro.doctree
Binary file not shown.
Binary file added main/.doctrees/getting_started/stages.doctree
Binary file not shown.
Binary file added main/.doctrees/index.doctree
Binary file not shown.
Binary file added main/.doctrees/notes/index.doctree
Binary file not shown.
Binary file added main/.doctrees/notes/pipeline_impl.doctree
Binary file not shown.
Binary file added main/.doctrees/overview.doctree
Binary file not shown.
Binary file added main/.doctrees/performance_analysis/bottleneck.doctree
Binary file not shown.
Binary file added main/.doctrees/performance_analysis/index.doctree
Binary file not shown.
Binary file added main/.doctrees/performance_analysis/stage_stats.doctree
Binary file not shown.
16 changes: 16 additions & 0 deletions main/_sources/api.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
API Reference
=============

.. autosummary::
:toctree: generated
:template: _custom_autosummary_module.rst
:caption: API Reference
:recursive:

spdl.io
spdl.dataloader
spdl.utils

.. toctree::

generated/libspdl/root
16 changes: 16 additions & 0 deletions main/_sources/generated/spdl.dataloader.Pipeline.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
spdl.dataloader.Pipeline
========================

.. currentmodule:: spdl.dataloader

.. autoclass:: Pipeline
:members:

.. rubric:: Methods

.. autosummary::
~Pipeline.auto_stop
~Pipeline.get_item
~Pipeline.get_iterator
~Pipeline.start
~Pipeline.stop
16 changes: 16 additions & 0 deletions main/_sources/generated/spdl.dataloader.PipelineBuilder.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
spdl.dataloader.PipelineBuilder
===============================

.. currentmodule:: spdl.dataloader

.. autoclass:: PipelineBuilder
:members:

.. rubric:: Methods

.. autosummary::
~PipelineBuilder.add_sink
~PipelineBuilder.add_source
~PipelineBuilder.aggregate
~PipelineBuilder.build
~PipelineBuilder.pipe
6 changes: 6 additions & 0 deletions main/_sources/generated/spdl.dataloader.PipelineFailure.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spdl.dataloader.PipelineFailure
===============================

.. currentmodule:: spdl.dataloader

.. autoexception:: PipelineFailure
13 changes: 13 additions & 0 deletions main/_sources/generated/spdl.dataloader.PipelineHook.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
spdl.dataloader.PipelineHook
============================

.. currentmodule:: spdl.dataloader

.. autoclass:: PipelineHook
:members:

.. rubric:: Methods

.. autosummary::
~PipelineHook.stage_hook
~PipelineHook.task_hook
13 changes: 13 additions & 0 deletions main/_sources/generated/spdl.dataloader.TaskStatsHook.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
spdl.dataloader.TaskStatsHook
=============================

.. currentmodule:: spdl.dataloader

.. autoclass:: TaskStatsHook
:members:

.. rubric:: Methods

.. autosummary::
~TaskStatsHook.stage_hook
~TaskStatsHook.task_hook
6 changes: 6 additions & 0 deletions main/_sources/generated/spdl.dataloader.create_task.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spdl.dataloader.create\_task
============================

.. currentmodule:: spdl.dataloader

.. autofunction:: create_task
162 changes: 162 additions & 0 deletions main/_sources/generated/spdl.dataloader.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
..
Custom template for our custom_autosummary.
The purpose of using custom_autosummary is list the entries on
the right side bar instead of the left side bar.
This is achieved with the combination of custom directive, template and CSS.
The `custom_autosummary` directive functions mostly like `autosummary`. We
pass `:toctree:` option to generate a doc page for each entry, but we use
our custom `:hide_from_toctree:` option so as not to attach them in ToC tree.

This template inserts a section header for each entry, so that they show up
in the right-side bar. The headers are hidden by CSS.

Because each entry will have its own table and their borders no longer match,
table borders are hidden by CSS and instead we use horizontal line.

.. raw:: html

<div class="custom_autosummary">

spdl.dataloader
===============

.. automodule:: spdl.dataloader

..
############################################################################
Functions
############################################################################


.. rubric:: Functions


create\_task
------------
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:

~spdl.dataloader.create_task





..
############################################################################
Attributes
############################################################################




..
############################################################################
Classes
############################################################################


.. rubric:: Classes


Pipeline
--------
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
:template: _custom_autosummary_class.rst

~spdl.dataloader.Pipeline


PipelineBuilder
---------------
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
:template: _custom_autosummary_class.rst

~spdl.dataloader.PipelineBuilder


PipelineHook
------------
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
:template: _custom_autosummary_class.rst

~spdl.dataloader.PipelineHook


TaskStatsHook
-------------
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:
:template: _custom_autosummary_class.rst

~spdl.dataloader.TaskStatsHook





..
############################################################################
Exceptions
############################################################################


.. rubric:: Exceptions


PipelineFailure
---------------
.. autosummary::
:toctree:
:nosignatures:
:hide_from_toctree:

~spdl.dataloader.PipelineFailure





..
############################################################################
Sub modules
############################################################################




..
############################################################################
Others
############################################################################








.. raw:: html

</div>
20 changes: 20 additions & 0 deletions main/_sources/generated/spdl.io.AudioFrames.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
spdl.io.AudioFrames
===================

.. currentmodule:: spdl.io

.. autoclass:: AudioFrames
:members:

.. rubric:: Methods

.. autosummary::
~AudioFrames.clone

.. rubric:: Attributes

.. autosummary::
~AudioFrames.num_channels
~AudioFrames.num_frames
~AudioFrames.sample_fmt
~AudioFrames.sample_rate
17 changes: 17 additions & 0 deletions main/_sources/generated/spdl.io.AudioPackets.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
spdl.io.AudioPackets
====================

.. currentmodule:: spdl.io

.. autoclass:: AudioPackets
:members:

.. rubric:: Methods

.. autosummary::
~AudioPackets.clone

.. rubric:: Attributes

.. autosummary::
~AudioPackets.timestamp
7 changes: 7 additions & 0 deletions main/_sources/generated/spdl.io.CPUBuffer.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
spdl.io.CPUBuffer
=================

.. currentmodule:: spdl.io

.. autoclass:: CPUBuffer
:members:
12 changes: 12 additions & 0 deletions main/_sources/generated/spdl.io.CUDABuffer.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
spdl.io.CUDABuffer
==================

.. currentmodule:: spdl.io

.. autoclass:: CUDABuffer
:members:

.. rubric:: Attributes

.. autosummary::
~CUDABuffer.device_index
7 changes: 7 additions & 0 deletions main/_sources/generated/spdl.io.CUDAConfig.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
spdl.io.CUDAConfig
==================

.. currentmodule:: spdl.io

.. autoclass:: CUDAConfig
:members:
7 changes: 7 additions & 0 deletions main/_sources/generated/spdl.io.DecodeConfig.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
spdl.io.DecodeConfig
====================

.. currentmodule:: spdl.io

.. autoclass:: DecodeConfig
:members:
7 changes: 7 additions & 0 deletions main/_sources/generated/spdl.io.DemuxConfig.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
spdl.io.DemuxConfig
===================

.. currentmodule:: spdl.io

.. autoclass:: DemuxConfig
:members:
15 changes: 15 additions & 0 deletions main/_sources/generated/spdl.io.Demuxer.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
spdl.io.Demuxer
===============

.. currentmodule:: spdl.io

.. autoclass:: Demuxer
:members:

.. rubric:: Methods

.. autosummary::
~Demuxer.demux_audio
~Demuxer.demux_image
~Demuxer.demux_video
~Demuxer.has_audio
7 changes: 7 additions & 0 deletions main/_sources/generated/spdl.io.EncodeConfig.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
spdl.io.EncodeConfig
====================

.. currentmodule:: spdl.io

.. autoclass:: EncodeConfig
:members:
Loading

0 comments on commit 131924e

Please sign in to comment.