docs.unity3d.com
    Show / Hide Table of Contents

    Class AveragePool

    Represents an AveragePool pooling layer. This calculates an output tensor by pooling the mean values of the input tensor across its spatial dimensions according to the given pool and stride values.

    Inheritance
    Object
    Layer
    AveragePool
    Inherited Members
    Layer.inputs
    Layer.name
    Layer.outputs
    Layer.flags
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.Sentis.Layers
    Syntax
    [Serializable]
    public class AveragePool : Layer

    Constructors

    AveragePool(String, String, Int32[], Int32[], Int32[], AutoPad)

    Initializes and returns an instance of AveragePool pooling layer.

    Declaration
    public AveragePool(string name, string input, int[] pool, int[] stride, int[] pad, AutoPad autopad = AutoPad.NotSet)
    Parameters
    Type Name Description
    String name

    The name to use for the output tensor of the layer.

    String input

    The name to use for the input tensor of the layer.

    Int32[] pool

    The size of the kernel along each spatial axis.

    Int32[] stride

    The stride along each spatial axis.

    Int32[] pad

    The lower and upper padding values for each spatial dimension, [pad_left, pad_right] for 1D, [pad_top, pad_bottom, pad_left, pad_right] for 2D, etc.

    AutoPad autopad

    The auto padding mode of the pool as an AutoPad. The default value is AutoPad.NotSet.

    Fields

    autopad

    The auto padding mode of the pool as an AutoPad.

    Declaration
    public AutoPad autopad
    Field Value
    Type Description
    AutoPad

    pad

    The lower and upper padding values for each spatial dimension. For example [pad_left, pad_right] for 1D, or [pad_top, pad_bottom, pad_left, pad_right] for 2D.

    If this is null the layer uses a default of [0, 0, ..., 0].

    Declaration
    public int[] pad
    Field Value
    Type Description
    Int32[]

    pool

    The size of the kernel along each spatial axis.

    Declaration
    public int[] pool
    Field Value
    Type Description
    Int32[]

    stride

    The stride along each spatial axis.

    If this is null the layer uses a default of [1, 1, ..., 1].

    Declaration
    public int[] stride
    Field Value
    Type Description
    Int32[]

    Methods

    Execute(Tensor[], ExecutionContext)

    Executes the layer using the operations and variables from the ExecutionContext and returns the output tensor.

    If the layer has more than one output, output tensors are saved to variables.

    Declaration
    public override Tensor Execute(Tensor[] inputTensors, ExecutionContext ctx)
    Parameters
    Type Name Description
    Tensor[] inputTensors
    ExecutionContext ctx
    Returns
    Type Description
    Tensor
    Overrides
    Layer.Execute(Tensor[], ExecutionContext)

    ToString()

    Returns a string that represents the Layer.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String
    Overrides
    Layer.ToString()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023