Skip to content

Expose nuclear norm order in linalg API #411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
RNT56 wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −6
Draft

Expose nuclear norm order in linalg API #411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions Source/MLX/Linalg.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ public enum MLXLinalg {
public enum NormKind: String, Sendable {
/// Frobenius norm
case fro

/// Nuclear norm, the sum of singular values
case nuc
}

/// Matrix or vector norm.
Expand All @@ -36,7 +39,7 @@ public enum MLXLinalg {
/// -2 | smallest singular value | as below
/// other | -- | sum(abs(x)**ord)**(1./ord)
///
/// > Nuclear norm and norms based on singular values are not yet implemented.
/// Nuclear norm and norms based on singular values are implemented by the linalg backend.
///
/// The Frobenius norm is given by G. H. Golub and C. F. Van Loan, *Matrix Computations*,
/// Baltimore, MD, Johns Hopkins University Press, 1985, pg. 15
Expand Down Expand Up @@ -91,7 +94,7 @@ public enum MLXLinalg {
/// -2 | smallest singular value | as below
/// other | -- | sum(abs(x)**ord)**(1./ord)
///
/// > Nuclear norm and norms based on singular values are not yet implemented.
/// Nuclear norm and norms based on singular values are implemented by the linalg backend.
///
/// The Frobenius norm is given by G. H. Golub and C. F. Van Loan, *Matrix Computations*,
/// Baltimore, MD, Johns Hopkins University Press, 1985, pg. 15
Expand Down Expand Up @@ -548,7 +551,7 @@ public enum MLXLinalg {
/// -2 | smallest singular value | as below
/// other | -- | sum(abs(x)**ord)**(1./ord)
///
/// > Nuclear norm and norms based on singular values are not yet implemented.
/// Nuclear norm and norms based on singular values are implemented by the linalg backend.
///
/// The Frobenius norm is given by G. H. Golub and C. F. Van Loan, *Matrix Computations*,
/// Baltimore, MD, Johns Hopkins University Press, 1985, pg. 15
Expand Down Expand Up @@ -597,7 +600,7 @@ public func norm(
/// -2 | smallest singular value | as below
/// other | -- | sum(abs(x)**ord)**(1./ord)
///
/// > Nuclear norm and norms based on singular values are not yet implemented.
/// Nuclear norm and norms based on singular values are implemented by the linalg backend.
///
/// The Frobenius norm is given by G. H. Golub and C. F. Van Loan, *Matrix Computations*,
/// Baltimore, MD, Johns Hopkins University Press, 1985, pg. 15
Expand Down
4 changes: 2 additions & 2 deletions Source/MLXLinalg/Linalg.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public let deprecationWarning: Void = ()
/// -2 | smallest singular value | as below
/// other | -- | sum(abs(x)**ord)**(1./ord)
///
/// > Nuclear norm and norms based on singular values are not yet implemented.
/// Nuclear norm and norms based on singular values are implemented by the linalg backend.
///
/// The Frobenius norm is given by G. H. Golub and C. F. Van Loan, *Matrix Computations*,
/// Baltimore, MD, Johns Hopkins University Press, 1985, pg. 15
Expand Down Expand Up @@ -81,7 +81,7 @@ public func norm(
/// -2 | smallest singular value | as below
/// other | -- | sum(abs(x)**ord)**(1./ord)
///
/// > Nuclear norm and norms based on singular values are not yet implemented.
/// Nuclear norm and norms based on singular values are implemented by the linalg backend.
///
/// The Frobenius norm is given by G. H. Golub and C. F. Van Loan, *Matrix Computations*,
/// Baltimore, MD, Johns Hopkins University Press, 1985, pg. 15
Expand Down
Loading