diff mbox series

[v3,34/35] ml/cnxk: update dependency info in driver docs

Message ID 20230927183052.17347-35-syalavarthi@marvell.com (mailing list archive)
State Changes Requested, archived
Delegated to: Jerin Jacob
Headers
Series Implemenation of revised ml/cnxk driver |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Srikanth Yalavarthi Sept. 27, 2023, 6:30 p.m. UTC 
  Added information related to external library dependencies
for ml/cnxk driver.

Signed-off-by: Srikanth Yalavarthi <syalavarthi@marvell.com>
---
 doc/guides/mldevs/cnxk.rst | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

Comments

Jerin Jacob Sept. 28, 2023, 4:12 a.m. UTC | #1 
On Thu, Sep 28, 2023 at 6:41 AM Srikanth Yalavarthi
<syalavarthi@marvell.com> wrote:
>
> Added information related to external library dependencies
> for ml/cnxk driver.
>
> Signed-off-by: Srikanth Yalavarthi <syalavarthi@marvell.com>
> ---
>  doc/guides/mldevs/cnxk.rst | 28 ++++++++++++++++++++++++++++
>  1 file changed, 28 insertions(+)
>
> diff --git a/doc/guides/mldevs/cnxk.rst b/doc/guides/mldevs/cnxk.rst
> index 197e1ed06f..afadc834e0 100644
> --- a/doc/guides/mldevs/cnxk.rst
> +++ b/doc/guides/mldevs/cnxk.rst
> @@ -47,6 +47,34 @@ or cross-compiled on an x86 platform.
>  Refer to :doc:`../platform/cnxk` for instructions to build your DPDK application.
>
>
> +Compilation Prerequisites
> +-------------------------
> +
> +This driver requires external libraries to optionally enable support for
> +models compiled using Apache TVM framework. The following dependencies are
> +not part of DPDK and must be installed separately:
> +
> +- **Jansson**
> +
> +  This library enables support to parse and read JSON files.
> +
> +- **libarchive**
> +
> +  Apached TVM framework generates compiled models as tar archives. This
> +  library enables support to decompress and read archive files in tar,
> +  xz and other formats.
> +
> +- **TVM**
> +
> +  Apache TVM provides a runtime library (libtvm_runtime) used to execute
> +  models on CPU cores or hardware accelerators.
> +
> +- **TVMDP**
> +
> +  Marvell's TVM dataplane library which works as an interface between TVM
> +  runtime and DPDK drivers. TVMDP library provides a simplified C interface
> +  for TVM's runtime based on C++.

It seems that it depends on a proprietary library. Please fix the
following for merging this series.

According to what was discussed in the Technical Board:
http://mails.dpdk.org/archives/dev/2019-June/135847.html
the dependency must be "freely available" to build it either source or
binary form. (Prefer in source form)

Also, Squash all doc updates to relevant patches.
Srikanth Yalavarthi Oct. 1, 2023, 12:32 a.m. UTC | #2 
> -----Original Message-----
> From: Jerin Jacob <jerinjacobk@gmail.com>
> Sent: 28 September 2023 09:43
> To: Srikanth Yalavarthi <syalavarthi@marvell.com>
> Cc: dev@dpdk.org; Shivah Shankar Shankar Narayan Rao
> <sshankarnara@marvell.com>; Anup Prabhu <aprabhu@marvell.com>;
> Prince Takkar <ptakkar@marvell.com>; techboard@dpdk.org; Srikanth
> Yalavarthi <syalavarthi@marvell.com>
> Subject: [EXT] Re: [PATCH v3 34/35] ml/cnxk: update dependency info in
> driver docs
> 
> External Email
> 
> ----------------------------------------------------------------------
> On Thu, Sep 28, 2023 at 6:41 AM Srikanth Yalavarthi
> <syalavarthi@marvell.com> wrote:
> >
> > Added information related to external library dependencies for ml/cnxk
> > driver.
> >
> > Signed-off-by: Srikanth Yalavarthi <syalavarthi@marvell.com>
> > ---
> >  doc/guides/mldevs/cnxk.rst | 28 ++++++++++++++++++++++++++++
> >  1 file changed, 28 insertions(+)
> >
> > diff --git a/doc/guides/mldevs/cnxk.rst b/doc/guides/mldevs/cnxk.rst
> > index 197e1ed06f..afadc834e0 100644
> > --- a/doc/guides/mldevs/cnxk.rst
> > +++ b/doc/guides/mldevs/cnxk.rst
> > @@ -47,6 +47,34 @@ or cross-compiled on an x86 platform.
> >  Refer to :doc:`../platform/cnxk` for instructions to build your DPDK
> application.
> >
> >
> > +Compilation Prerequisites
> > +-------------------------
> > +
> > +This driver requires external libraries to optionally enable support
> > +for models compiled using Apache TVM framework. The following
> > +dependencies are not part of DPDK and must be installed separately:
> > +
> > +- **Jansson**
> > +
> > +  This library enables support to parse and read JSON files.
> > +
> > +- **libarchive**
> > +
> > +  Apached TVM framework generates compiled models as tar archives.
> > + This  library enables support to decompress and read archive files
> > + in tar,  xz and other formats.
> > +
> > +- **TVM**
> > +
> > +  Apache TVM provides a runtime library (libtvm_runtime) used to
> > + execute  models on CPU cores or hardware accelerators.
> > +
> > +- **TVMDP**
> > +
> > +  Marvell's TVM dataplane library which works as an interface between
> > + TVM  runtime and DPDK drivers. TVMDP library provides a simplified C
> > + interface  for TVM's runtime based on C++.
> 
> It seems that it depends on a proprietary library. Please fix the following for
> merging this series.
> 
> According to what was discussed in the Technical Board:
> https://urldefense.proofpoint.com/v2/url?u=http-
> 3A__mails.dpdk.org_archives_dev_2019-
> 2DJune_135847.html&d=DwIFaQ&c=nKjWec2b6R0mOyPaz7xtfQ&r=SNPqUk
> Gl0n_Ms1iJa_6wD6LBwX8efL_NOyXvAX-
> iCMI&m=diNZcWaywZP478LbvQPYaK6-
> w1mq1giW2phwy5s7roDoNUFO6TSUdyOFHVZnutCI&s=8WbivGMgGdsgKaKT
> I1QKfTTnq56JJqnyxGUczzyYm3I&e=
> the dependency must be "freely available" to build it either source or binary
> form. (Prefer in source form)

We are working hosting TVMDP library on github. Will submit revised series with the details.

> 
> Also, Squash all doc updates to relevant patches.

Ack.
Srikanth Yalavarthi Oct. 17, 2023, 5:03 p.m. UTC | #3 
> -----Original Message-----
> From: Jerin Jacob <jerinjacobk@gmail.com>
> Sent: 28 September 2023 09:43
> To: Srikanth Yalavarthi <syalavarthi@marvell.com>
> Cc: dev@dpdk.org; Shivah Shankar Shankar Narayan Rao
> <sshankarnara@marvell.com>; Anup Prabhu <aprabhu@marvell.com>;
> Prince Takkar <ptakkar@marvell.com>; techboard@dpdk.org; Srikanth
> Yalavarthi <syalavarthi@marvell.com>
> Subject: [EXT] Re: [PATCH v3 34/35] ml/cnxk: update dependency info in
> driver docs
> 
> External Email
> 
> ----------------------------------------------------------------------
> On Thu, Sep 28, 2023 at 6:41 AM Srikanth Yalavarthi
> <syalavarthi@marvell.com> wrote:
> >
> > Added information related to external library dependencies for ml/cnxk
> > driver.
> >
> > Signed-off-by: Srikanth Yalavarthi <syalavarthi@marvell.com>
> > ---
> >  doc/guides/mldevs/cnxk.rst | 28 ++++++++++++++++++++++++++++
> >  1 file changed, 28 insertions(+)
> >
> > diff --git a/doc/guides/mldevs/cnxk.rst b/doc/guides/mldevs/cnxk.rst
> > index 197e1ed06f..afadc834e0 100644
> > --- a/doc/guides/mldevs/cnxk.rst
> > +++ b/doc/guides/mldevs/cnxk.rst
> > @@ -47,6 +47,34 @@ or cross-compiled on an x86 platform.
> >  Refer to :doc:`../platform/cnxk` for instructions to build your DPDK
> application.
> >
> >
> > +Compilation Prerequisites
> > +-------------------------
> > +
> > +This driver requires external libraries to optionally enable support
> > +for models compiled using Apache TVM framework. The following
> > +dependencies are not part of DPDK and must be installed separately:
> > +
> > +- **Jansson**
> > +
> > +  This library enables support to parse and read JSON files.
> > +
> > +- **libarchive**
> > +
> > +  Apached TVM framework generates compiled models as tar archives.
> > + This  library enables support to decompress and read archive files
> > + in tar,  xz and other formats.
> > +
> > +- **TVM**
> > +
> > +  Apache TVM provides a runtime library (libtvm_runtime) used to
> > + execute  models on CPU cores or hardware accelerators.
> > +
> > +- **TVMDP**
> > +
> > +  Marvell's TVM dataplane library which works as an interface between
> > + TVM  runtime and DPDK drivers. TVMDP library provides a simplified C
> > + interface  for TVM's runtime based on C++.
> 
> It seems that it depends on a proprietary library. Please fix the following for
> merging this series.
> 
> According to what was discussed in the Technical Board:
> https://urldefense.proofpoint.com/v2/url?u=http-
> 3A__mails.dpdk.org_archives_dev_2019-
> 2DJune_135847.html&d=DwIFaQ&c=nKjWec2b6R0mOyPaz7xtfQ&r=SNPqUk
> Gl0n_Ms1iJa_6wD6LBwX8efL_NOyXvAX-
> iCMI&m=diNZcWaywZP478LbvQPYaK6-
> w1mq1giW2phwy5s7roDoNUFO6TSUdyOFHVZnutCI&s=8WbivGMgGdsgKaKT
> I1QKfTTnq56JJqnyxGUczzyYm3I&e=
> the dependency must be "freely available" to build it either source or binary
> form. (Prefer in source form)
> 
TVMDP library is now hosted on GitHub. Updated the documentation with required details and build steps.

> Also, Squash all doc updates to relevant patches.
Done. Squashed to corresponding patches.
diff mbox series

Patch

diff --git a/doc/guides/mldevs/cnxk.rst b/doc/guides/mldevs/cnxk.rst
index 197e1ed06f..afadc834e0 100644
--- a/doc/guides/mldevs/cnxk.rst
+++ b/doc/guides/mldevs/cnxk.rst
@@ -47,6 +47,34 @@  or cross-compiled on an x86 platform.
 Refer to :doc:`../platform/cnxk` for instructions to build your DPDK application.
 
 
+Compilation Prerequisites
+-------------------------
+
+This driver requires external libraries to optionally enable support for
+models compiled using Apache TVM framework. The following dependencies are
+not part of DPDK and must be installed separately:
+
+- **Jansson**
+
+  This library enables support to parse and read JSON files.
+
+- **libarchive**
+
+  Apached TVM framework generates compiled models as tar archives. This
+  library enables support to decompress and read archive files in tar,
+  xz and other formats.
+
+- **TVM**
+
+  Apache TVM provides a runtime library (libtvm_runtime) used to execute
+  models on CPU cores or hardware accelerators.
+
+- **TVMDP**
+
+  Marvell's TVM dataplane library which works as an interface between TVM
+  runtime and DPDK drivers. TVMDP library provides a simplified C interface
+  for TVM's runtime based on C++.
+
 Initialization
 --------------