.. _op_ai_onnx_ml_TreeEnsembleClassifier-3:

TreeEnsembleClassifier - version 3
==================================

This page documents version **3** of operator **TreeEnsembleClassifier**. See :doc:`TreeEnsembleClassifier` for the latest version (since version 5).

- **Domain**: ``ai.onnx.ml``
- **Since version**: 3

Tree Ensemble classifier. Returns the top class for each of N inputs. 
The attributes named 'nodes_X' form a sequence of tuples, associated by
index into the sequences, which must all be of equal length. These tuples
define the nodes. 
Similarly, all fields prefixed with ```class_``` are tuples of votes at the leaves.
A leaf may have multiple votes, where each vote is weighted by
the associated class_weights index. 
One and only one of classlabels_strings or classlabels_int64s
will be defined. The class_ids are indices into this list.
All fields ending with  _as_tensor  can be used instead of the
same parameter without the suffix if the element type is double and not float.

**Inputs**

- **X** (*T1*): Input of shape [N,F]

**Outputs**

- **Y** (*T2*): N, Top class for each point
- **Z** (*tensor(float)*): The class score for each class, for each point, a tensor of shape [N,E].

**Type Constraints**

- **T1**: The input type must be a tensor of a numeric type.
  Allowed types: tensor(double), tensor(float), tensor(int32), tensor(int64).
- **T2**: The output type will be a tensor of strings or integers, depending on which of the classlabels\* attributes is used.
  Allowed types: tensor(int64), tensor(string).

Differences with previous version (1)
-------------------------------------

**SchemaDiff**: ``TreeEnsembleClassifier`` (domain ``'ai.onnx.ml'``)

* old version: 1
* new version: 3
* breaking: no

**Documentation:**

* line similarity: 0.82 (+3/-1 lines)

.. code-block:: diff

    --- TreeEnsembleClassifier v1
    +++ TreeEnsembleClassifier v3
    @@ -1,5 +1,5 @@
     
    -    Tree Ensemble classifier.  Returns the top class for each of N inputs.<br>
    +    Tree Ensemble classifier. Returns the top class for each of N inputs.<br>
         The attributes named 'nodes_X' form a sequence of tuples, associated by
         index into the sequences, which must all be of equal length. These tuples
         define the nodes.<br>
    @@ -8,3 +8,5 @@
         the associated class_weights index.<br>
         One and only one of classlabels_strings or classlabels_int64s
         will be defined. The class_ids are indices into this list.
    +    All fields ending with <i>_as_tensor</i> can be used instead of the
    +    same parameter without the suffix if the element type is double and not float.