Skip to content

Commit 7555da7

Browse files
daviskingdavisking
committed
update docs
1 parent 8161cfc commit 7555da7

File tree

10 files changed

+431
-23
lines changed

10 files changed

+431
-23
lines changed

‎dlib/constexpr_if.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ namespace dlib
6161
template<typename T>
6262
auto perform_correct_action(T& obj)
6363
{
64-
return switch(
64+
return switch_(
6565
types_<T>{},
6666
[&](types_<A>, auto _) {
6767
return _(obj).set_something_specific_to_A_and_return_something();
@@ -81,7 +81,7 @@ namespace dlib
8181
template<typename T>
8282
auto transfer_state(T& a, T& b)
8383
{
84-
return switch(
84+
return switch_(
8585
bools(std::is_move_constructible<T>{}, std::is_copy_constructible<T>{}),
8686
[&](true_t, auto, auto _) {
8787
// T is both move-constructible. Copy semantics can be anything
@@ -110,4 +110,4 @@ namespace dlib
110110

111111
}
112112

113-
#endif //DLIB_IF_CONSTEXPR_H
113+
#endif //DLIB_IF_CONSTEXPR_H

‎dlib/media/ffmpeg_demuxer.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ namespace dlib
362362
devices (X11, webcam, microphone, ...) and network streams such as RTSP, HTTP, and more.
363363
Note that a video file, e.g. MP4, can contain multiple streams: video, audio, subtitles, etc.
364364
This class can decode both video and audio at the same time.
365-
For audio files, e.g. MP3, FLAG, it only decodes audio. (obs)
365+
For audio files, e.g. MP3, FLAG, it only decodes audio.
366366
!*/
367367

368368
struct args

‎docs/docs/algorithms.xml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,35 @@
117117
<item>find_optimal_momentum_filter</item>
118118
</section>
119119

120+
<section>
121+
<name>Fourier Transforms</name>
122+
<item>
123+
<name>fft</name>
124+
<link>dlib/fft/fft.h.html#fft</link>
125+
</item>
126+
<item>
127+
<name>fftr</name>
128+
<link>dlib/fft/fft.h.html#fftr</link>
129+
</item>
130+
<item>
131+
<name>ifftr</name>
132+
<link>dlib/fft/fft.h.html#ifftr</link>
133+
</item>
134+
<item>
135+
<name>fft_size</name>
136+
<link>dlib/fft/fft.h.html#fft_size</link>
137+
</item>
138+
139+
<item>
140+
<name>fft_inplace</name>
141+
<link>dlib/fft/fft.h.html#fft_inplace</link>
142+
</item>
143+
<item>
144+
<name>ifft_inplace</name>
145+
<link>dlib/fft/fft.h.html#ifft_inplace</link>
146+
</item>
147+
</section>
148+
120149
</top>
121150
</menu>
122151

‎docs/docs/linear_algebra.xml‎

Lines changed: 78 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -417,14 +417,6 @@
417417
<name>csv</name>
418418
<link>dlib/matrix/matrix_abstract.h.html#csv</link>
419419
</item>
420-
<item>
421-
<name>fft</name>
422-
<link>dlib/matrix/matrix_fft_abstract.h.html#fft</link>
423-
</item>
424-
<item>
425-
<name>ifft</name>
426-
<link>dlib/matrix/matrix_fft_abstract.h.html#ifft</link>
427-
</item>
428420
<item>
429421
<name>is_col_vector</name>
430422
<link>dlib/matrix/matrix_utilities_abstract.h.html#is_col_vector</link>
@@ -616,6 +608,84 @@
616608
</item>
617609
</sub>
618610
</item>
611+
<item nolink="true">
612+
<name>Fourier Transforms</name>
613+
<sub>
614+
<item>
615+
<name>fft</name>
616+
<link>dlib/matrix/matrix_fft_abstract.h.html#fft</link>
617+
</item>
618+
<item>
619+
<name>ifft</name>
620+
<link>dlib/matrix/matrix_fft_abstract.h.html#ifft</link>
621+
</item>
622+
<item>
623+
<name>fftr</name>
624+
<link>dlib/matrix/matrix_fft_abstract.h.html#fftr</link>
625+
</item>
626+
<item>
627+
<name>ifftr</name>
628+
<link>dlib/matrix/matrix_fft_abstract.h.html#ifftr</link>
629+
</item>
630+
<item>
631+
<name>fft_inplace</name>
632+
<link>dlib/matrix/matrix_fft_abstract.h.html#fft_inplace</link>
633+
</item>
634+
<item>
635+
<name>ifft_inplace</name>
636+
<link>dlib/matrix/matrix_fft_abstract.h.html#ifft_inplace</link>
637+
</item>
638+
639+
<item>
640+
<name>make_hann</name>
641+
<link>dlib/matrix/matrix_fft_abstract.h.html#make_hann</link>
642+
</item>
643+
<item>
644+
<name>make_blackman</name>
645+
<link>dlib/matrix/matrix_fft_abstract.h.html#make_blackman</link>
646+
</item>
647+
<item>
648+
<name>make_blackman_nuttall</name>
649+
<link>dlib/matrix/matrix_fft_abstract.h.html#make_blackman_nuttall</link>
650+
</item>
651+
<item>
652+
<name>make_blackman_harris</name>
653+
<link>dlib/matrix/matrix_fft_abstract.h.html#make_blackman_harris</link>
654+
</item>
655+
<item>
656+
<name>make_blackman_harris7</name>
657+
<link>dlib/matrix/matrix_fft_abstract.h.html#make_blackman_harris7</link>
658+
</item>
659+
<item>
660+
<name>make_kaiser</name>
661+
<link>dlib/matrix/matrix_fft_abstract.h.html#make_kaiser</link>
662+
</item>
663+
664+
<item>
665+
<name>stft</name>
666+
<link>dlib/matrix/matrix_fft_abstract.h.html#stft</link>
667+
</item>
668+
<item>
669+
<name>istft</name>
670+
<link>dlib/matrix/matrix_fft_abstract.h.html#istft</link>
671+
</item>
672+
673+
<item>
674+
<name>stftr</name>
675+
<link>dlib/matrix/matrix_fft_abstract.h.html#stftr</link>
676+
</item>
677+
<item>
678+
<name>istftr</name>
679+
<link>dlib/matrix/matrix_fft_abstract.h.html#istftr</link>
680+
</item>
681+
682+
683+
<item>
684+
<name>xcorr_fft</name>
685+
<link>dlib/matrix/matrix_conv_abstract.h.html#xcorr_fft</link>
686+
</item>
687+
</sub>
688+
</item>
619689
</section>
620690

621691
<section>

‎docs/docs/main_menu.xml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,10 @@
296296
<name>Deep Learning Max-Margin Object Detection</name>
297297
<link>dnn_mmod_ex.cpp.html</link>
298298
</item>
299+
<item>
300+
<name>Deep learning Language Modeling</name>
301+
<link>slm_basic_train_ex.cpp.html</link>
302+
</item>
299303
<item>
300304
<name>Self-supervised deep feature learning</name>
301305
<link>dnn_self_supervised_learning_ex.cpp.html</link>
@@ -650,6 +654,55 @@
650654
<name>Multithreaded Object</name>
651655
<link>multithreaded_object_ex.cpp.html</link>
652656
</item>
657+
658+
<item>
659+
<name>FFMPEG: query codec capability</name>
660+
<link>ffmpeg_info_ex.cpp.html</link>
661+
</item>
662+
<item>
663+
<name>FFMPEG: capture audio</name>
664+
<link>ffmpeg_file_to_speaker_ex.cpp.html</link>
665+
</item>
666+
<item>
667+
<name>FFMPEG: capture audio to file</name>
668+
<link>ffmpeg_microphone_to_file_ex.cpp.html</link>
669+
</item>
670+
<item>
671+
<name>FFMPEG: RTSP</name>
672+
<link>ffmpeg_rtsp_ex.cpp.html</link>
673+
</item>
674+
<item>
675+
<name>FFMPEG: screen grabbing</name>
676+
<link>ffmpeg_screen_grab_ex.cpp.html</link>
677+
</item>
678+
<item>
679+
<name>FFMPEG: read video with demuxer</name>
680+
<link>ffmpeg_video_demuxing_ex.cpp.html</link>
681+
</item>
682+
<item>
683+
<name>FFMPEG: demux images and audio</name>
684+
<link>ffmpeg_video_demuxing2_ex.cpp.html</link>
685+
</item>
686+
<item>
687+
<name>FFMPEG: decode video</name>
688+
<link>ffmpeg_video_decoding_ex.cpp.html</link>
689+
</item>
690+
<item>
691+
<name>FFMPEG: decode video another example</name>
692+
<link>ffmpeg_video_decoding2_ex.cpp.html</link>
693+
</item>
694+
<item>
695+
<name>FFMPEG: encode video</name>
696+
<link>ffmpeg_video_encoding_ex.cpp.html</link>
697+
</item>
698+
<item>
699+
<name>FFMPEG: encode video with muxer</name>
700+
<link>ffmpeg_video_muxing_ex.cpp.html</link>
701+
</item>
702+
<item>
703+
<name>FFMPEG: face pose from webcam</name>
704+
<link>ffmpeg_webcam_face_pose_ex.cpp.html</link>
705+
</item>
653706
</sub>
654707
</item>
655708
</section>

‎docs/docs/metaprogramming.xml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@
9595
<item>is_same_object</item>
9696
<item>assign_zero_if_built_in_scalar_type</item>
9797
<item>DLIB_MAKE_HAS_MEMBER_FUNCTION_TEST</item>
98+
<item>switch_</item>
9899
</section>
99100

100101
<section>
@@ -994,6 +995,19 @@ or you can omit the error message and call it like:
994995
</component>
995996

996997

998+
<!-- ************************************************************************* -->
999+
1000+
<component>
1001+
<name>switch_</name>
1002+
<file>dlib/constexpr_if.h</file>
1003+
<spec_file link="true">dlib/constexpr_if.h</spec_file>
1004+
<description>
1005+
This function allows you to do compile time dispatch similar to what you can do with constexpr if in C++17, but only requires a C++14 compiler.
1006+
</description>
1007+
1008+
</component>
1009+
1010+
9971011
<!-- ************************************************************************* -->
9981012

9991013
<component>

‎docs/docs/ml.xml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,51 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
282282
<name>inception</name>
283283
<link>dlib/dnn/layers_abstract.h.html#inception</link>
284284
</item>
285+
286+
<item>
287+
<name>input_tensor</name>
288+
<link>dlib/dnn/layers_abstract.h.html#input_tensor_</link>
289+
</item>
290+
<item>
291+
<name>dropout_rate</name>
292+
<link>dlib/dnn/layers_abstract.h.html#dropout_rate_</link>
293+
</item>
294+
<item>
295+
<name>rms_norm</name>
296+
<link>dlib/dnn/layers_abstract.h.html#rms_norm_</link>
297+
</item>
298+
<item>
299+
<name>transpose</name>
300+
<link>dlib/dnn/layers_abstract.h.html#transpose_</link>
301+
</item>
302+
<item>
303+
<name>tril</name>
304+
<link>dlib/dnn/layers_abstract.h.html#tril_</link>
305+
</item>
306+
<item>
307+
<name>positional_encodings</name>
308+
<link>dlib/dnn/layers_abstract.h.html#positional_encodings_</link>
309+
</item>
310+
<item>
311+
<name>embeddings</name>
312+
<link>dlib/dnn/layers_abstract.h.html#embeddings_</link>
313+
</item>
314+
<item>
315+
<name>multm_prev</name>
316+
<link>dlib/dnn/layers_abstract.h.html#multm_prev_</link>
317+
</item>
318+
<item>
319+
<name>slice</name>
320+
<link>dlib/dnn/layers_abstract.h.html#slice_</link>
321+
</item>
322+
<item>
323+
<name>linear</name>
324+
<link>dlib/dnn/layers_abstract.h.html#linear_</link>
325+
</item>
326+
<item>
327+
<name>reshape_to</name>
328+
<link>dlib/dnn/layers_abstract.h.html#reshape_to_</link>
329+
</item>
285330
</sub>
286331
</item>
287332
<item nolink="true">
@@ -551,6 +596,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
551596
<item>count_ranking_inversions</item>
552597
<item>learn_platt_scaling</item>
553598
<item>process_sample</item>
599+
<item>bpe_tokenizer</item>
554600

555601

556602

@@ -2563,6 +2609,22 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
25632609
</description>
25642610
</component>
25652611

2612+
<!-- ************************************************************************* -->
2613+
2614+
<component>
2615+
<name>bpe_tokenizer</name>
2616+
<file>dlib/tokenizer.h</file>
2617+
<spec_file link="true">dlib/tokenizer/bpe_tokenizer_abstract.h</spec_file>
2618+
<description>
2619+
This class implements a Byte Pair Encoding (BPE) tokenizer, which is a subword
2620+
tokenization algorithm commonly used in natural language processing (NLP). The
2621+
BPE algorithm iteratively merges the most frequent pairs of bytes or characters
2622+
to form a vocabulary of subword units. This approach is particularly useful for
2623+
handling out-of-vocabulary words and reducing the size of the vocabulary while
2624+
maintaining the ability to represent any text.
2625+
</description>
2626+
</component>
2627+
25662628
<!-- ************************************************************************* -->
25672629

25682630
<component>

0 commit comments

Comments
 (0)