Fixing long tables and table widths

Author: rkedar1

doc/documents/data_movement/data_movement.rst

@@ -4,7 +4,7 @@ Data Movement
 =============
 
 Most processors and accelerators achieve optimal performance by keeping the kernel 
-input data in “close” local memories on those processors (for example, CCMs). Meanwhile, 
+input data in "close" local memories on those processors (for example, CCMs). Meanwhile, 
 the total amount of data that needs to be operated on is usually bigger than the 
 sizes of those CCMs, so you must copy data into CCMs for processing.  
 
@@ -89,21 +89,26 @@ read from the array. The other values are "don't care".
 
 The size of the array is defined by ``MLI_MAX_RANK``.
 
+.. tabularcolumns:: |\Y{0.25}|\Y{0.15}|\Y{0.4}|
+
 .. _t_mli_mov_cfg_desc: 
 .. table:: mli_mov_cfg Structure Field Description
    :align: center
-   :widths: auto 
+   :class: longtable 
 
    +---------------------+----------------+---------------------------------------------------------------------+
    | **Field Name**      | **Type**       | **Description**                                                     |
    +=====================+================+=====================================================================+
    | ``offset``          | ``uint32_t[]`` | Start coordinate in the source tensor. Values must be smaller       |
    |                     |                | than the shape of the source tensor.                                |
    +---------------------+----------------+---------------------------------------------------------------------+
-   |                     |                || Size of the copy in elements per dimension.                        |
-   | ``size``            | ``uint32_t[]`` || Restrictions:                                                      |
-   |                     |                || :math:`Size[d] + offset[d] <= src->shape[d]`                       |
-   |                     |                || If :math:`size=0` is provided, the size is computed from the input |
+   |                     |                | Size of the copy in elements per dimension.                         |
+   |                     |                |                                                                     |   
+   | ``size``            | ``uint32_t[]`` | Restrictions:                                                       |
+   |                     |                |                                                                     |      
+   |                     |                | :math:`Size[d] + offset[d] <= src->shape[d]`                        |
+   |                     |                |                                                                     |      
+   |                     |                | If :math:`size=0` is provided, the size is computed from the input  |
    |                     |                | size and the cfg parameters.                                        |
    +---------------------+----------------+---------------------------------------------------------------------+
    |                     |                | Subsample factor for each dimension. Default value is 1, which      |
@@ -222,10 +227,12 @@ into the cfg struct while the remaining parameters are set to their default valu
 transformations, there is a generic helper function available or the user can manually fill the cfg struct 
 parameters.  Note that the mli_mov_cfg structure is described in detail in :ref:`t_mli_mov_cfg_desc`.
 
+.. tabularcolumns:: |\Y{0.4}|\Y{0.6}|
+
 .. _t_desc_helper_func:
 .. table:: Description of Helper Functions for Data Move Config Struct
    :align: center
-   :widths: auto 
+   :class: longtable 
 
    +------------------------------------+---------------------------------------------------------------------+ 
    | **Function Name**                  | **Description**                                                     |
@@ -404,10 +411,11 @@ initialization. Table :ref:`t_mli_mov_prep` describes the parameters of this fun
    mli_mov_prepare(mli_mov_handle_t* h, const mli_tensor* src, const mli_mov_cfg_t* cfg, mli_tensor* dst);
 ..
 
+.. tabularcolumns:: |\Y{0.35}|\Y{0.65}|
+
 .. _t_mli_mov_prep:
 .. table:: mli_mov_prepare Parameters
    :align: center
-   :widths: auto
 
    +--------------------------+-------------------------------------------------------------+
    | **Parameter Name**       | **Description**                                             |

doc/documents/mli_api_data/data_layouts.rst

@@ -9,6 +9,8 @@ dimensions and its meaning) is important as it dictates the way calculations are
 Other kernels are layout-agnostic, or imply non-vision meaning of dimensions. The table 
 :ref:`t_layout_letter_desc` describes the letters used for the layout description.
 
+.. tabularcolumns:: |\Y{0.2}|\Y{0.4}|
+
 .. _t_layout_letter_desc:
 .. table:: Layout Letter Description
    :align: center
@@ -39,7 +41,7 @@ MLI Data layout (HWCN)
 ^^^^^^^^^^^^^^^^^^^^^^
 
 Layout-dependent MLI kernels use the HWC layout for tensors and HWCN layout for weights. 
-The Height/Width/Channel layout is also referred as “Interleaved” or “Channel last”. 
+The Height/Width/Channel layout is also referred as "Interleaved" or "Channel last". 
 The smallest stride between dimension elements in memory is for C (channel or depth) 
 followed by the width and then the height. The height is the least frequently changing 
 index. 
@@ -75,11 +77,12 @@ transpose function can also be used to convert one layout into another layout.
 Description
 """""""""""
 
+.. tabularcolumns:: |\Y{0.2}|\Y{0.4}|
+
 .. _t_hwcn_spec:
 .. table:: The HWCN Layout
    :align: center
-   :widths: 60, 130 
-   
+     
    +--------------------+---------------------------------------------+
    | **Aspect**         | **Comment**                                 |
    +====================+=============================================+

doc/documents/mli_api_data/data_structures.rst

@@ -35,10 +35,12 @@ shape of this array, its data format, and the way it is organized in memory.
 
 The table :ref:`mli_tnsr_struc` describes the fields in the ``mli_tensor`` structure.
 
+.. tabularcolumns:: |\Y{0.2}|\Y{0.3}|\Y{0.5}|
+
 .. _mli_tnsr_struc:  
 .. table:: mli_tensor Structure Field Descriptions
    :align: center
-   :widths: 50, 50, 130 
+   :class: longtable
 
    +-------------------+------------------------+-----------------------------------------------------------------------------+
    | **Field name**    | **type**               | **Comment**                                                                 |
@@ -145,10 +147,12 @@ It stores pointer to data or a single value that intend to be directly used in a
 
 :ref:`t_mli_d_cont_strct` describes the fields in the ``mli_data_container`` struture. 
 
+.. tabularcolumns:: |\Y{0.2}|\Y{0.2}|\Y{0.6}|
+
 .. _t_mli_d_cont_strct:
 .. table:: mli_data_container Structure Field Description
    :align: center
-   :widths: 50, 50, 130 
+   :class: longtable
 
    +--------------------+------------------+----------------------------------------------------------------------+
    | **Field Name**     | **Type**         | **Comment**                                                          |
@@ -204,10 +208,11 @@ and other  implementation specific things. ``mli_element_type`` is defined as fo
 
 :ref:`t_mli_el_type` describes the entities in the ``mli_element_type`` union. 
 
+.. tabularcolumns:: |\Y{0.25}|\Y{0.5}|
+
 .. _t_mli_el_type:
 .. table:: mli_element_type Enumeration Values Description
    :align: center
-   :widths: 50, 50, 130 
 
    +-----------------------+----------------------------------------------------------------------------+
    | **Enumeration Value** | **Description**                                                            |
@@ -272,10 +277,12 @@ quantization parameters can vary. For instance in a CHW layout, ``dim`` = 0 mean
 a different zero point and a different scale factor. The size of these arrays is the same as the number of 
 channels in the tensor ``(array_size = shape[dim])``.
 
+.. tabularcolumns:: |\Y{0.3}|\Y{0.3}|\Y{0.4}|
+
 .. _t_mli_el_p_union:
 .. table:: mli_element_params Union Field Description
    :align: center
-   :widths: 50, 50, 130 
+   :class: longtable 
 
    +------------------------+------------------------+-----------------------------------------------------------------------------+
    | **Field Name**         | **Type**               | **Comment**                                                                 |
@@ -336,6 +343,10 @@ channels in the tensor ``(array_size = shape[dim])``.
        // Filling other fields of tsr_fx16
 
    ..
+..
+
+.. admonition:: Example 
+   :class: "admonition tip"
 
    SA8 tensor quantized on per-tensor level might be populated in the following way:
 
@@ -360,6 +371,10 @@ channels in the tensor ``(array_size = shape[dim])``.
       // Filling other fields of tsr_sa8
 
    ..
+..
+
+.. admonition:: Example 
+   :class: "admonition tip"
 
    SA8 tensor quantized on per-axis level might be populated in the following way:
 
@@ -415,12 +430,14 @@ The ``mli_lut`` struct describes the data in the LUT, including the format of it
 ..
 
 The following table describes the fields in the ``mli_lut`` structure.
+
+.. tabularcolumns:: |\Y{0.2}|\Y{0.3}|\Y{0.5}|
 
 .. _mli_lut_struct_table:  
 .. table:: mli_lut Structure Field Descriptions
    :align: center
-   :widths: 50, 50, 130 
-   
+   :class: longtable
+
    +-------------------+------------------------+-----------------------------------------------------------------------------+
    | **Field name**    | **type**               | **Comment**                                                                 |
    +===================+========================+=============================================================================+

doc/documents/mli_api_data/error_codes.rst

@@ -6,10 +6,12 @@ Error Codes
 Most functions return a value of type mli_status. This is an enumeration type with fields 
 as described in table :ref:`t_mli_status_enum`.
 
+.. tabularcolumns:: |\Y{0.4}|\Y{0.15}|\Y{0.45}|
+   
 .. _t_mli_status_enum:
 .. table:: mli_status Enum Fields
    :align: center
-   :widths: 50, 50, 130 
+   :class: longtable
 
    +-------------------------------------+----------------+--------------------------------------------------------------------------+
    | **Field name**                      | **value**      | **Description**                                                          |