mirror of
https://github.com/ml-explore/mlx.git
synced 2025-07-22 01:21:14 +08:00
6b0d30bb85
* implemented vector_norm in cpp added linalg to mlx * implemented vector_norm python binding * renamed vector_norm to norm, implemented norm without provided ord * completed the implementation of the norm * added tests * removed unused import in linalg.cpp * updated python bindings * added some tests for python bindings * handling inf, -inf as numpy does, more extensive tests of compatibility with numpy * added better docs and examples * refactored mlx.linalg.norm bindings * reused existing util for implementation of linalg.norm * more tests * fixed a bug with no ord and axis provided * removed unused imports * some style and API consistency updates to linalg norm * remove unused includes * fix python tests * fixed a bug with frobenius norm of a complex-valued matrix * complex for vector too --------- Co-authored-by: Awni Hannun <awni@apple.com>
64 lines
1.7 KiB
C++
64 lines
1.7 KiB
C++
// Copyright © 2023 Apple Inc.
|
|
|
|
#pragma once
|
|
|
|
#include <optional>
|
|
|
|
#include "mlx/array.h"
|
|
#include "mlx/device.h"
|
|
#include "mlx/ops.h"
|
|
#include "mlx/stream.h"
|
|
|
|
namespace mlx::core::linalg {
|
|
|
|
/**
|
|
* Compute vector or matrix norms.
|
|
*
|
|
* - If axis and ord are both unspecified, computes the 2-norm of flatten(x).
|
|
* - If axis is not provided but ord is, then x must be either 1D or 2D.
|
|
* - If axis is provided, but ord is not, then the 2-norm (or Frobenius norm
|
|
* for matrices) is computed along the given axes. At most 2 axes can be
|
|
* specified.
|
|
* - If both axis and ord are provided, then the corresponding matrix or vector
|
|
* norm is computed. At most 2 axes can be specified.
|
|
*/
|
|
array norm(
|
|
const array& a,
|
|
const double ord,
|
|
const std::optional<std::vector<int>>& axis = std::nullopt,
|
|
bool keepdims = false,
|
|
StreamOrDevice s = {});
|
|
inline array norm(
|
|
const array& a,
|
|
const double ord,
|
|
int axis,
|
|
bool keepdims = false,
|
|
StreamOrDevice s = {}) {
|
|
return norm(a, ord, std::vector<int>{axis}, keepdims, s);
|
|
}
|
|
array norm(
|
|
const array& a,
|
|
const std::string& ord,
|
|
const std::optional<std::vector<int>>& axis = std::nullopt,
|
|
bool keepdims = false,
|
|
StreamOrDevice s = {});
|
|
inline array norm(
|
|
const array& a,
|
|
const std::string& ord,
|
|
int axis,
|
|
bool keepdims = false,
|
|
StreamOrDevice s = {}) {
|
|
return norm(a, ord, std::vector<int>{axis}, keepdims, s);
|
|
}
|
|
array norm(
|
|
const array& a,
|
|
const std::optional<std::vector<int>>& axis = std::nullopt,
|
|
bool keepdims = false,
|
|
StreamOrDevice s = {});
|
|
inline array
|
|
norm(const array& a, int axis, bool keepdims = false, StreamOrDevice s = {}) {
|
|
return norm(a, std::vector<int>{axis}, keepdims, s);
|
|
}
|
|
|
|
} // namespace mlx::core::linalg
|