DirectMLX

  • Artigo

DirectMLX é uma biblioteca auxiliar somente de cabeçalho C++ para DirectML, destinada a facilitar a composição de operadores individuais em gráficos.

O DirectMLX fornece wrappers convenientes para todos os tipos de operador DirectML (DML), bem como sobrecargas intuitivas do operador, o que torna mais simples instanciar operadores DML e encadeá-los em gráficos complexos.

Onde encontrar DirectMLX.h

DirectMLX.h é distribuído como software de código aberto sob a licença MIT. A versão mais recente pode ser encontrada no DirectML GitHub.

Requisitos da versão

O DirectMLX requer o DirectML versão 1.4.0 ou mais recente (consulte Histórico de versões do DirectML). Não há suporte para versões mais antigas do DirectML.

DirectMLX.h requer um compilador compatível com C++11, incluindo (mas não limitado a):

  • Visual Studio 2017
  • Visual Studio 2019
  • Clang 10

Observe que um compilador C++17 (ou mais recente) é a opção que recomendamos. A compilação para C++11 é possível, mas requer o uso de bibliotecas de terceiros (como GSL e Abseil) para substituir a funcionalidade de biblioteca padrão ausente.

Se você tiver uma configuração que não consiga compilar DirectMLX.h, registre um problema em nosso GitHub.

Uso básico

#include <DirectML.h>
#include <DirectMLX.h>

IDMLDevice* device;

/* ... */

dml::Graph graph(device);

// Input tensor of type FLOAT32 and sizes { 1, 2, 3, 4 }
auto x = dml::InputTensor(graph, 0, dml::TensorDesc(DML_TENSOR_DATA_TYPE_FLOAT32, {1, 2, 3, 4}));

// Create an operator to compute the square root of x
auto y = dml::Sqrt(x);

// Compile a DirectML operator from the graph. When executed, this compiled operator will compute
// the square root of its input.
DML_EXECUTION_FLAGS flags = DML_EXECUTION_FLAG_NONE;
ComPtr<IDMLCompiledOperator> op = graph.Compile(flags, { y });

// Now initialize and dispatch the DML operator as usual

Aqui está outro exemplo, que cria um gráfico DirectML capaz de calcular a fórmula quadrática.

#include <DirectML.h>
#include <DirectMLX.h>

IDMLDevice* device;

/* ... */

std::pair<dml::Expression, dml::Expression>
    QuadraticFormula(dml::Expression a, dml::Expression b, dml::Expression c)
{
    // Quadratic formula: given an equation of the form ax^2 + bx + c = 0, x can be found by:
    //   x = -b +/- sqrt(b^2 - 4ac) / (2a)
    // https://en.wikipedia.org/wiki/Quadratic_formula

    // Note: DirectMLX provides operator overloads for common mathematical expressions. So for 
    // example a*c is equivalent to dml::Multiply(a, c).
    auto x1 = -b + dml::Sqrt(b*b - 4*a*c) / (2*a);
    auto x2 = -b - dml::Sqrt(b*b - 4*a*c) / (2*a);

    return { x1, x2 };
}

/* ... */

dml::Graph graph(device);

dml::TensorDimensions inputSizes = {1, 2, 3, 4};
auto a = dml::InputTensor(graph, 0, dml::TensorDesc(DML_TENSOR_DATA_TYPE_FLOAT32, inputSizes));
auto b = dml::InputTensor(graph, 1, dml::TensorDesc(DML_TENSOR_DATA_TYPE_FLOAT32, inputSizes));
auto c = dml::InputTensor(graph, 2, dml::TensorDesc(DML_TENSOR_DATA_TYPE_FLOAT32, inputSizes));

auto [x1, x2] = QuadraticFormula(a, b, c);

// When executed with input tensors a, b, and c, this compiled operator computes the two outputs
// of the quadratic formula, and returns them as two output tensors x1 and x2
DML_EXECUTION_FLAGS flags = DML_EXECUTION_FLAG_NONE;
ComPtr<IDMLCompiledOperator> op = graph.Compile(flags, { x1, x2 });

// Now initialize and dispatch the DML operator as usual

Mais exemplos

Exemplos completos usando DirectMLX podem ser encontrados no repositório DirectML GitHub.

Opções de tempo de compilação

O DirectMLX oferece suporte a #define em tempo de compilação para personalizar várias partes do cabeçalho.

Opção Descrição
DMLX_NO_EXCEPTIONS Se #define, faz com que os erros resultem em uma chamada para std::abort, em vez de lançar uma exceção. Isso é definido por padrão se as exceções não estão disponíveis (por exemplo, se as exceções foram desabilitadas nas opções do compilador).
DMLX_USE_WIL Se #define'd, as exceções são lançadas usando os tipos de exceção da Biblioteca de Implementação do Windows. Caso contrário, tipos de exceção padrão (como std::runtime_error) serão usados em vez disso. Essa opção não terá efeito se DMLX_NO_EXCEPTIONS estiver definido.
DMLX_USE_ABSEIL Se #define'd, usa Abseil como substitutos drop-in para tipos de biblioteca padrão não disponíveis em C++11. Esses tipos incluem absl::optional (no lugar de std::optional), absl::Span (no lugar de std::span) e absl::InlinedVector.
DMLX_USE_GSL Controla se o GSL deve ser usado como substituto do std::span. Se #define'd, os usos de std::span são substituídos por gsl::span em compiladores sem implementações nativas de std::span. Caso contrário, uma implementação suspensa embutida será fornecida. Observe que essa opção só é usada ao compilar em um compilador pré-C++20 sem suporte para std::span, e quando nenhuma outra substituição de biblioteca padrão drop-in (como Abseil) está em uso.

Controlar o layout do tensor

Para a maioria dos operadores, o DirectMLX calcula as propriedades dos tensores de saída do operador em seu nome. Por exemplo, ao executar um dml::Reduce entre eixos { 0, 2, 3 } com um tensor de entrada de tamanhos { 3, 4, 5, 6 }, o DirectMLX calculará automaticamente as propriedades do tensor de saída, incluindo a forma correta de { 1, 4, 1, 1 }.

No entanto, as outras propriedades de um tensor de saída incluem Strides, TotalTensorSizeInBytes e GuaranteedBaseOffsetAlignment. Por padrão, o DirectMLX define essas propriedades de forma que o tensor não tenha striding, nenhum alinhamento de deslocamento de base garantido e um tamanho total do tensor em bytes, conforme calculado por DMLCalcBufferTensorSize.

O DirectMLX oferece suporte à capacidade de personalizar essas propriedades de tensor de saída, usando objetos conhecidos como políticas de tensor. Um TensorPolicy é um retorno de chamada personalizável que é invocado pelo DirectMLX e retorna propriedades de tensor de saída conforme o tipo de dados computados, os sinalizadores e os tamanhos de um tensor.

As políticas de tensor podem ser definidas no objeto dml::Graph e serão usadas para todos os operadores subsequentes nesse gráfico. As políticas de tensor também podem ser definidas diretamente ao construir um TensorDesc.

O layout de tensores produzidos pelo DirectMLX pode, portanto, ser controlado definindo um TensorPolicy que define os passos apropriados em seus tensores.

Exemplo 1

// Define a policy, which is a function that returns a TensorProperties given a data type,
// flags, and sizes.
dml::TensorProperties MyCustomPolicy(
    DML_TENSOR_DATA_TYPE dataType,
    DML_TENSOR_FLAGS flags,
    Span<const uint32_t> sizes)
{
    // Compute your custom strides, total tensor size in bytes, and guaranteed base
    // offset alignment
    dml::TensorProperties props;
    props.strides = /* ... */;
    props.totalTensorSizeInBytes = /* ... */;
    props.guaranteedBaseOffsetAlignment = /* ... */;
    return props;
};

// Set the policy on the dml::Graph
dml::Graph graph(/* ... */);
graph.SetTensorPolicy(dml::TensorPolicy(&MyCustomPolicy));

Exemplo 2

O DirectMLX também fornece algumas políticas de tensor alternativas internas. A política InterleavedChannel, por exemplo, é fornecida como uma conveniência, e pode ser usada para produzir tensores com passos para que eles sejam escritos na ordem NHWC.

// Set the InterleavedChannel policy on the dml::Graph
dml::Graph graph(/* ... */);
graph.SetTensorPolicy(dml::TensorPolicy::InterleavedChannel());

// When executed, the tensor `result` will be in NHWC layout (rather than the default NCHW)
auto result = dml::Convolution(/* ... */);

Confira também