Skip to content

Commit a9e04c8

Browse files
mthrokci
authored andcommitted
Update docs
1 parent fa50daf commit a9e04c8

418 files changed

Lines changed: 12112 additions & 5869 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

main/_sources/examples.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Examples
77
:caption: Examples
88
:recursive:
99

10+
llm_finetune.llm_finetuning
1011
image_dataloading
1112
video_dataloading
1213
imagenet_classification

main/_sources/generated/libspdl/define_frames_8h_1a9beaa64113e413112d43491ba5c13670.rst.txt

Lines changed: 0 additions & 14 deletions
This file was deleted.

main/_sources/generated/libspdl/define_frames_8h_1ac2ad95ac922a100ec27340436eb94940.rst.txt

Lines changed: 0 additions & 14 deletions
This file was deleted.

main/_sources/generated/libspdl/define_frames_8h_1ac99c83df576500933a3691deb137be6d.rst.txt

Lines changed: 0 additions & 14 deletions
This file was deleted.

main/_sources/generated/libspdl/file__home_runner_work_spdl_spdl_src_libspdl_core_conversion.h.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ Functions
5353
---------
5454

5555

56-
- :ref:`exhale_function_conversion_8h_1ae55bfac2f391205603d77241fc25ca1a`
57-
5856
- :ref:`exhale_function_conversion_8h_1a3f08ca7a5c09ab82603e239e50dff4d7`
5957

58+
- :ref:`exhale_function_conversion_8h_1ae55bfac2f391205603d77241fc25ca1a`
59+
6060
- :ref:`exhale_function_conversion_8h_1a295b42ad20d2569806d9a15009a44ca8`
6161

6262
- :ref:`exhale_function_conversion_8h_1a87d61e0429716c42f3a5f5e85aad5b61`

main/_sources/generated/libspdl/file__home_runner_work_spdl_spdl_src_libspdl_core_frames.h.rst.txt

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -75,17 +75,6 @@ Functions
7575
- :ref:`exhale_function_frames_8h_1a30fbfab5f9ecfb208928ebdaca7f4349`
7676

7777

78-
Defines
79-
-------
80-
81-
82-
- :ref:`exhale_define_frames_8h_1ac2ad95ac922a100ec27340436eb94940`
83-
84-
- :ref:`exhale_define_frames_8h_1ac99c83df576500933a3691deb137be6d`
85-
86-
- :ref:`exhale_define_frames_8h_1a9beaa64113e413112d43491ba5c13670`
87-
88-
8978
Typedefs
9079
--------
9180

main/_sources/generated/libspdl/program_listing_file__home_runner_work_spdl_spdl_src_libspdl_core_buffer.h.rst.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,15 @@ Program Listing for File buffer.h
4040
size_t depth = sizeof(uint8_t);
4141
4242
void* data();
43+
44+
void* data() const;
4345
};
4446
4547
using CPUBufferPtr = std::unique_ptr<CPUBuffer>;
4648
4749
// Factory functions
4850
49-
CPUBufferPtr cpu_buffer(
51+
[[nodiscard]] CPUBufferPtr cpu_buffer(
5052
const std::vector<size_t>& shape,
5153
ElemClass elem_class = ElemClass::UInt,
5254
size_t depth = sizeof(uint8_t),

main/_sources/generated/libspdl/program_listing_file__home_runner_work_spdl_spdl_src_libspdl_core_demuxing.h.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,13 @@ Program Listing for File demuxing.h
6969
7070
using DemuxerPtr = std::unique_ptr<Demuxer>;
7171
72-
DemuxerPtr make_demuxer(
72+
[[nodiscard]] DemuxerPtr make_demuxer(
7373
const std::string& src,
7474
const SourceAdaptorPtr& adaptor = nullptr,
7575
const std::optional<DemuxConfig>& dmx_cfg = std::nullopt,
7676
const std::optional<std::string>& name = std::nullopt);
7777
78-
DemuxerPtr make_demuxer(
78+
[[nodiscard]] DemuxerPtr make_demuxer(
7979
const std::string_view data,
8080
const std::optional<DemuxConfig>& dmx_cfg = std::nullopt,
8181
const std::optional<std::string>& name = std::nullopt);

main/_sources/generated/libspdl/program_listing_file__home_runner_work_spdl_spdl_src_libspdl_core_filter_graph.h.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,6 @@ Program Listing for File filter_graph.h
5959
6060
using FilterGraphPtr = std::unique_ptr<FilterGraph>;
6161
62-
FilterGraphPtr make_filter_graph(const std::string& filter_desc);
62+
[[nodiscard]] FilterGraphPtr make_filter_graph(const std::string& filter_desc);
6363
6464
} // namespace spdl::core

main/_sources/generated/libspdl/program_listing_file__home_runner_work_spdl_spdl_src_libspdl_core_frames.h.rst.txt

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,6 @@ Program Listing for File frames.h
4949
5050
using AnyFrames = std::variant<AudioFramesPtr, VideoFramesPtr, ImageFramesPtr>;
5151
52-
#define _IS_AUDIO (media == MediaType::Audio)
53-
#define _IS_VIDEO (media == MediaType::Video)
54-
#define _IS_IMAGE (media == MediaType::Image)
55-
5652
template <MediaType media>
5753
class Frames {
5854
private:
@@ -105,39 +101,35 @@ Program Listing for File frames.h
105101
// Audio specific
106102
107103
int get_sample_rate() const
108-
requires _IS_AUDIO;
104+
requires(media == MediaType::Audio);
109105
110106
int get_num_channels() const
111-
requires _IS_AUDIO;
107+
requires(media == MediaType::Audio);
112108
113109
// Common to Image/Video
114110
115111
int get_num_planes() const
116-
requires(_IS_IMAGE || _IS_VIDEO);
112+
requires(media == MediaType::Image || media == MediaType::Video);
117113
118114
int get_width() const
119-
requires(_IS_IMAGE || _IS_VIDEO);
115+
requires(media == MediaType::Image || media == MediaType::Video);
120116
121117
int get_height() const
122-
requires(_IS_IMAGE || _IS_VIDEO);
118+
requires(media == MediaType::Image || media == MediaType::Video);
123119
124120
// Video specific
125121
126122
VideoFramesPtr slice(int start, int stop, int step) const
127-
requires _IS_VIDEO;
123+
requires(media == MediaType::Video);
128124
129125
VideoFramesPtr slice(const std::vector<int64_t>& index) const
130-
requires _IS_VIDEO;
126+
requires(media == MediaType::Video);
131127
132128
ImageFramesPtr slice(int64_t index) const
133-
requires _IS_VIDEO;
129+
requires(media == MediaType::Video);
134130
};
135131
136132
template <MediaType media>
137133
FramesPtr<media> clone(const Frames<media>& src);
138134
139-
#undef _IS_AUDIO
140-
#undef _IS_VIDEO
141-
#undef _IS_IMAGE
142-
143135
} // namespace spdl::core

0 commit comments

Comments
 (0)