diff mbox series

[FFmpeg-devel,3/6] doc/filters: documentation to options for backend

Message ID 1619434136-17760-3-git-send-email-lance.lmwang@gmail.com
State New
Headers show
Series [FFmpeg-devel,1/6] doc/filters: correct http link
Related show

Checks

Context Check Description
andriy/x86_make success Make finished
andriy/x86_make_fate success Make fate finished
andriy/PPC64_make success Make finished
andriy/PPC64_make_fate success Make fate finished

Commit Message

Limin Wang April 26, 2021, 10:48 a.m. UTC
From: Limin Wang <lance.lmwang@gmail.com>

Signed-off-by: Limin Wang <lance.lmwang@gmail.com>
---
 doc/filters.texi | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Guo, Yejun April 27, 2021, 2:40 a.m. UTC | #1
> -----Original Message-----
> From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of
> lance.lmwang@gmail.com
> Sent: 2021年4月26日 18:49
> To: ffmpeg-devel@ffmpeg.org
> Cc: Limin Wang <lance.lmwang@gmail.com>
> Subject: [FFmpeg-devel] [PATCH 3/6] doc/filters: documentation to options
> for backend
> 
> From: Limin Wang <lance.lmwang@gmail.com>
> 
> Signed-off-by: Limin Wang <lance.lmwang@gmail.com>
> ---
>  doc/filters.texi | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/doc/filters.texi b/doc/filters.texi
> index e99d70a..a959127 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -10159,6 +10159,7 @@ and the second line is the name of label id 1,
> etc.
>  The label id is considered as name if the label file is not provided.
> 
>  @item backend_configs
> +@item options

options is old and not direct for meaning, and we prefer the new better
name backend_configs.

>  Set the configs to be passed into backend
> 
>  @item async
> @@ -10214,6 +10215,10 @@ Set the input name of the dnn network.
>  @item output
>  Set the output name of the dnn network.
> 
> +@item backend_configs
> +@item options
> +Set the configs to be passed into backend
> +
>  @item async
>  use DNN async execution if set (default: set),
>  roll back to sync execution if the backend does not support async.
> @@ -18905,6 +18910,10 @@ Note that different backends use different
> file formats. TensorFlow backend
>  can load files for both formats, while native backend can load files for
> only
>  its format.
> 
> +@item backend_configs
> +@item options
> +Set the configs to be passed into backend
> +
>  @item scale_factor
>  Set scale factor for SRCNN model. Allowed values are @code{2}, @code{3}
> and @code{4}.
>  Default value is @code{2}. Scale factor is necessary for SRCNN model,
> because it accepts
> --
> 1.8.3.1
> 
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel@ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
> 
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
Limin Wang April 27, 2021, 3:36 a.m. UTC | #2
On Tue, Apr 27, 2021 at 02:40:06AM +0000, Guo, Yejun wrote:
> 
> 
> > -----Original Message-----
> > From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of
> > lance.lmwang@gmail.com
> > Sent: 2021年4月26日 18:49
> > To: ffmpeg-devel@ffmpeg.org
> > Cc: Limin Wang <lance.lmwang@gmail.com>
> > Subject: [FFmpeg-devel] [PATCH 3/6] doc/filters: documentation to options
> > for backend
> > 
> > From: Limin Wang <lance.lmwang@gmail.com>
> > 
> > Signed-off-by: Limin Wang <lance.lmwang@gmail.com>
> > ---
> >  doc/filters.texi | 9 +++++++++
> >  1 file changed, 9 insertions(+)
> > 
> > diff --git a/doc/filters.texi b/doc/filters.texi
> > index e99d70a..a959127 100644
> > --- a/doc/filters.texi
> > +++ b/doc/filters.texi
> > @@ -10159,6 +10159,7 @@ and the second line is the name of label id 1,
> > etc.
> >  The label id is considered as name if the label file is not provided.
> > 
> >  @item backend_configs
> > +@item options
> 
> options is old and not direct for meaning, and we prefer the new better
> name backend_configs.

Both of the options are using in the code still, so I'm glad to document them.
If we prefer to backend_configs, it's better to mark the options out of date
in the code.

> 
> >  Set the configs to be passed into backend
> > 
> >  @item async
> > @@ -10214,6 +10215,10 @@ Set the input name of the dnn network.
> >  @item output
> >  Set the output name of the dnn network.
> > 
> > +@item backend_configs
> > +@item options
> > +Set the configs to be passed into backend
> > +
> >  @item async
> >  use DNN async execution if set (default: set),
> >  roll back to sync execution if the backend does not support async.
> > @@ -18905,6 +18910,10 @@ Note that different backends use different
> > file formats. TensorFlow backend
> >  can load files for both formats, while native backend can load files for
> > only
> >  its format.
> > 
> > +@item backend_configs
> > +@item options
> > +Set the configs to be passed into backend
> > +
> >  @item scale_factor
> >  Set scale factor for SRCNN model. Allowed values are @code{2}, @code{3}
> > and @code{4}.
> >  Default value is @code{2}. Scale factor is necessary for SRCNN model,
> > because it accepts
> > --
> > 1.8.3.1
> > 
> > _______________________________________________
> > ffmpeg-devel mailing list
> > ffmpeg-devel@ffmpeg.org
> > https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
> > 
> > To unsubscribe, visit link above, or email
> > ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel@ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
> 
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
Guo, Yejun April 27, 2021, 3:51 a.m. UTC | #3
> -----Original Message-----
> From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of
> lance.lmwang@gmail.com
> Sent: 2021年4月27日 11:36
> To: ffmpeg-devel@ffmpeg.org
> Subject: Re: [FFmpeg-devel] [PATCH 3/6] doc/filters: documentation to
> options for backend
> 
> On Tue, Apr 27, 2021 at 02:40:06AM +0000, Guo, Yejun wrote:
> >
> >
> > > -----Original Message-----
> > > From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of
> > > lance.lmwang@gmail.com
> > > Sent: 2021年4月26日 18:49
> > > To: ffmpeg-devel@ffmpeg.org
> > > Cc: Limin Wang <lance.lmwang@gmail.com>
> > > Subject: [FFmpeg-devel] [PATCH 3/6] doc/filters: documentation to
> options
> > > for backend
> > >
> > > From: Limin Wang <lance.lmwang@gmail.com>
> > >
> > > Signed-off-by: Limin Wang <lance.lmwang@gmail.com>
> > > ---
> > >  doc/filters.texi | 9 +++++++++
> > >  1 file changed, 9 insertions(+)
> > >
> > > diff --git a/doc/filters.texi b/doc/filters.texi
> > > index e99d70a..a959127 100644
> > > --- a/doc/filters.texi
> > > +++ b/doc/filters.texi
> > > @@ -10159,6 +10159,7 @@ and the second line is the name of label id
> 1,
> > > etc.
> > >  The label id is considered as name if the label file is not provided.
> > >
> > >  @item backend_configs
> > > +@item options
> >
> > options is old and not direct for meaning, and we prefer the new better
> > name backend_configs.
> 
> Both of the options are using in the code still, so I'm glad to document
> them.
> If we prefer to backend_configs, it's better to mark the options out of date
> in the code.
> 

yes, could you help to send a patch for it, thanks.
Limin Wang April 27, 2021, 5:48 a.m. UTC | #4
On Tue, Apr 27, 2021 at 03:51:34AM +0000, Guo, Yejun wrote:
> 
> 
> > -----Original Message-----
> > From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of
> > lance.lmwang@gmail.com
> > Sent: 2021年4月27日 11:36
> > To: ffmpeg-devel@ffmpeg.org
> > Subject: Re: [FFmpeg-devel] [PATCH 3/6] doc/filters: documentation to
> > options for backend
> > 
> > On Tue, Apr 27, 2021 at 02:40:06AM +0000, Guo, Yejun wrote:
> > >
> > >
> > > > -----Original Message-----
> > > > From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of
> > > > lance.lmwang@gmail.com
> > > > Sent: 2021年4月26日 18:49
> > > > To: ffmpeg-devel@ffmpeg.org
> > > > Cc: Limin Wang <lance.lmwang@gmail.com>
> > > > Subject: [FFmpeg-devel] [PATCH 3/6] doc/filters: documentation to
> > options
> > > > for backend
> > > >
> > > > From: Limin Wang <lance.lmwang@gmail.com>
> > > >
> > > > Signed-off-by: Limin Wang <lance.lmwang@gmail.com>
> > > > ---
> > > >  doc/filters.texi | 9 +++++++++
> > > >  1 file changed, 9 insertions(+)
> > > >
> > > > diff --git a/doc/filters.texi b/doc/filters.texi
> > > > index e99d70a..a959127 100644
> > > > --- a/doc/filters.texi
> > > > +++ b/doc/filters.texi
> > > > @@ -10159,6 +10159,7 @@ and the second line is the name of label id
> > 1,
> > > > etc.
> > > >  The label id is considered as name if the label file is not provided.
> > > >
> > > >  @item backend_configs
> > > > +@item options
> > >
> > > options is old and not direct for meaning, and we prefer the new better
> > > name backend_configs.
> > 
> > Both of the options are using in the code still, so I'm glad to document
> > them.
> > If we prefer to backend_configs, it's better to mark the options out of date
> > in the code.
> > 
> 
> yes, could you help to send a patch for it, thanks.

OK, will send a patch later.

> 
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel@ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
> 
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
diff mbox series

Patch

diff --git a/doc/filters.texi b/doc/filters.texi
index e99d70a..a959127 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -10159,6 +10159,7 @@  and the second line is the name of label id 1, etc.
 The label id is considered as name if the label file is not provided.
 
 @item backend_configs
+@item options
 Set the configs to be passed into backend
 
 @item async
@@ -10214,6 +10215,10 @@  Set the input name of the dnn network.
 @item output
 Set the output name of the dnn network.
 
+@item backend_configs
+@item options
+Set the configs to be passed into backend
+
 @item async
 use DNN async execution if set (default: set),
 roll back to sync execution if the backend does not support async.
@@ -18905,6 +18910,10 @@  Note that different backends use different file formats. TensorFlow backend
 can load files for both formats, while native backend can load files for only
 its format.
 
+@item backend_configs
+@item options
+Set the configs to be passed into backend
+
 @item scale_factor
 Set scale factor for SRCNN model. Allowed values are @code{2}, @code{3} and @code{4}.
 Default value is @code{2}. Scale factor is necessary for SRCNN model, because it accepts