Skip to main content
torch.js has not been released yet.
torch.js logotorch.js logotorch.js
PlaygroundContact
Login
Documentation
IntroductionType SafetyTensor ExpressionsTensor IndexingEinsumEinopsAutogradTraining a ModelProfiling & MemoryPyTorch MigrationBest PracticesRuntimesPerformancePyTorch CompatibilityBenchmarksDType Coverage
choleskycholesky_excholesky_inversecholesky_solveCholeskyExOptionsCholeskyInverseOptionsCholeskyOptionsCholeskySolveOptionscondCondOptionscrossCrossOptionsdetdiagonalDiagonalOptionseigeighEighOptionseigvalseigvalshhouseholder_productinvinv_exInvExOptionsldl_factorldl_factor_exldl_solveLdlFactorExOptionsLdlFactorOptionsLdlSolveOptionslobpcgLobpcgOptionslogdetlstsqLstsqOptionslulu_factorlu_factor_exlu_solvelu_unpackLuFactorExOptionsLuFactorOptionsLuOptionsLuSolveOptionsLuUnpackOptionsmatrix_expmatrix_normmatrix_powermatrix_rankMatrixNormOptionsMatrixRankOptionsmulti_dotnormNormOptionspca_lowrankPcaLowrankOptionspinvPinvOptionsqrQrOptionsslogdetsolvesolve_exsolve_triangularSolveExOptionsSolveOptionsSolveTriangularOptionssvdsvd_lowrankSvdLowrankOptionsSvdOptionssvdvalstensorinvTensorinvOptionstensorsolveTensorsolveOptionstracetriangular_solveTriangularSolveOptionsvanderVanderOptionsvecdotVecdotOptionsvector_normVectorNormOptions
absacosacoshAdaptivePool1dShapeAdaptivePool2dShapeaddaddbmmAddbmmOptionsaddcdivAddcdivOptionsaddcmulAddcmulOptionsaddmmAddmmOptionsaddmvAddmvOptionsaddrAddrOptionsadjointallallcloseAllcloseOptionsAlphaBetaOptionsamaxaminaminmaxAminmaxOptionsangleanyapplyOutarangeare_deterministic_algorithms_enabledargmaxargminargsortargwhereas_stridedas_tensorasinasinhAssertNoShapeErrorAssertNotErrorAsStridedOptionsAtat_error_index_out_of_boundsatanatan2atanhatleast_1datleast_2datleast_3dAtShapeautocast_decrement_nestingautocast_increment_nestingautograd_gradient_mismatch_errorautograd_not_registered_errorAutogradConfigAutogradDeviceAutogradDTypeAutogradEntryAutogradHandleAutogradHandleImplAxesRecordBackwardFnbaddbmmBaddbmmOptionsbartlett_windowBaseKernelConfigbatch_dimensions_do_not_match_errorbernoulliBernoulliOptionsBinaryBackwardFnBinaryBroadcastResultBinaryDTypeBinaryKernelConfigCPUBinaryKernelCPUBinaryOpConfigBinaryOpNamesBinaryOpSchemaBinaryOptionsbincountBincountOptionsbitwise_andbitwise_left_shiftbitwise_notbitwise_orbitwise_right_shiftbitwise_xorblackman_windowblock_diagbmmBooleanDTypeRulebroadcast_error_incompatible_dimensionsbroadcast_shapesbroadcast_tensorsbroadcast_toBroadcastShapeBroadcastShapeRulebroadcastShapesbucketizeBucketizeOptionsBufferUsagebuildEinopsErrorbuildErrorMessagecanBroadcastTocartesian_prodcatCatOptionsCatShapeCauchyOptionscdistCdistOptionsceilceluCeluFunctionalOptionschain_matmulCheckShapeErrorCholeskyShapechunkchunk_error_dim_out_of_rangeChunkOptionsclampClampOptionsclear_autocast_cacheclearEinopsCacheclearEinsumCacheclonecolumn_stackcombinationsCombinationsOptionscompiled_with_cxx11_abicomplexconjconj_physicalcontiguousConv1dShapeConv2dShapeConv3dShapeConvTranspose2dShapecopysigncorrcoefcoscoshcount_nonzeroCountNonzeroOptionscovcoverage_reportcoverageReportCoverageReportCovOptionsCPUForwardFnCPUKernelConfigCPUKernelEntryCPUOnlyResultCPUTensorDatacreateCumExtremeResultcreateTorchCreationOpSchemaCumExtremeResultcummaxcummincumprodCumShapecumsumcumulative_trapezoidCumulativeOptionsCumulativeOptionsWithDimdeg2raddetachDeterministicOptionsDetShapeDevicedevice_error_requiresDeviceBufferDeviceCapabilitiesDeviceCheckedResultDeviceConfigDeviceContextDeviceEntryDeviceHandleDeviceInputDeviceOptionsDeviceRegistryDeviceTypediagdiag_embedDiagEmbedOptionsdiagflatDiagflatOptionsDiagFlatOptionsdiagonal_scatterDiagonalOptionsDiagonalScatterOptionsDiagOptionsDiagShapediffDiffOptionsdigammadimension_error_out_of_rangeDispatchConfigdistDistOptionsdivdotDotShapeRuleDoubleDoubleDimdropoutDropoutFunctionalOptionsdsplitdstackDTypedtype_already_registered_errordtype_components_mismatch_errordtype_not_found_errorDTypeComponentsDTypeConfigDTypeCoverageReportDTypeDisplayConfigDTypeEntryDTypeHandleDTypeHandleImplDTypeInfoDTypeRegistryDTypeRuleDTypeSerializationConfigDynamicShapeEigShapeeinops_error_ambiguous_decompositioneinops_error_anonymous_in_outputeinops_error_dimension_mismatcheinops_error_invalid_patterneinops_error_reduce_undefined_outputeinops_error_repeat_missing_sizeeinops_error_undefined_axiseinsumeinsum_error_dimension_mismatcheinsum_error_index_out_of_rangeeinsum_error_invalid_equationeinsum_error_invalid_sublist_elementeinsum_error_operand_count_mismatcheinsum_error_subscript_rank_mismatcheinsum_error_unknown_output_indexEinsumOptionsEinsumOutputShapeEllipsiseluelu_EluFunctionalOptionsembedding_bag_error_requires_2d_inputemptyempty_cacheempty_likeeqequalerferfcerfinvexpexp2expandexpand_asexpand_error_incompatibleExpandShapeexpm1ExponentialOptionseyeEyeOptionsfftFFTOptionsfindKernelWithPredicatefindSimilarPatternsflattenFlattenOptionsFlattenShapeflipflip_error_dim_out_of_rangefliplrFlipShapeflipudfloat_powerFloatDTypeRulefloorfloor_dividefmaxfminfmodformatEquationErrorformatShapefracfrexpfrombufferfullfull_likefunction_already_registered_errorFunctionConfigFunctionEntryFunctionHandlegathergather_error_dim_out_of_rangeGatherShapegcdgegeluGeometricOptionsget_autocast_cpu_dtypeget_autocast_gpu_dtypeget_autocast_ipu_dtypeget_autocast_xla_dtypeget_default_deviceget_default_dtypeget_deterministic_debug_modeget_device_configget_device_contextget_device_moduleget_dtype_infoget_file_pathget_float32_matmul_precisionget_num_interop_threadsget_num_threadsget_op_infoget_printoptionsget_real_dtypeget_rng_stategetAutogradgetDTypegetEinopsCacheSizegetEinsumCacheSizegetFunctiongetKernelgetMethodgetOpInfoGetOpKindGetOpSchemagetScalarKernelgluGluFunctionalOptionsGradContextGradFnGradientsForgtHalfHalfDimhamming_windowhann_windowhardshrinkhardsigmoidhardswishhardtanhhardtanh_HardtanhFunctionalOptionshas_autogradhas_devicehas_dtypehas_kernelhasAutogradhasDTypehasFunctionhasKernelhasMethodhasScalarKernelHasShapeErrorheavisidehistcHistcOptionshistogramHistogramOptionsHistogramResulthsplithstackhypoti0IdentityShapeifftimagindex_addindex_copyindex_fillindex_putindex_reduceindex_selectindex_select_error_dim_out_of_rangeIndexPutOptionsIndexSelectShapeIndexSpecIndicesOptionsIndicesSpecinitialize_deviceInputsForInsertDiminvalid_config_errorinverseInverseShapeirfftis_anomaly_check_nan_enabledis_anomaly_enabledis_autocast_cache_enabledis_autocast_cpu_enabledis_autocast_ipu_enabledis_autocast_xla_enabledis_complexis_complex_dtypeis_cpu_only_modeis_deterministic_algorithms_warn_only_enabledis_floating_pointis_floating_point_dtypeis_inference_mode_enabledis_nonzerois_tensoris_warn_always_enabledis_webgpu_availableIs2DIsAtLeast1DIsBinaryOpIsBinaryOpNameiscloseIscloseOptionsisfiniteisinisinfisnanisneginfisposinfisrealIsReductionOpIsReductionOpNameIsRegistryErrorIsShapeErroristftISTFTOptionsIsUnaryOpIsUnaryOpNameitem_error_not_scalarItemResultkaiser_windowKaiserWindowOptionskernel_not_registered_errorkernel_signature_mismatch_errorKernelConfigKernelConfigWebGPUKernelEntryKernelHandleKernelInfoKernelPredicateKernelRegistryKernelWebGPUkronkthvalueKthvalueOptionslcmldexpleleaky_reluleaky_relu_LeakyReluFunctionalOptionslerplevenshteinDistancelgammalinalg_error_not_square_matrixlinalg_error_requires_2dlinalg_error_requires_at_least_2dlinearlinspacelist_custom_deviceslist_custom_dtypeslist_deviceslist_dtypeslist_functionslist_kernelslist_methodslist_opslistCustomDTypeslistDTypeslistFunctionslistKernelsListKernelsOptionslistMethodslistOpsListOpsOptionsloglog_softmaxlog10log1plog2logaddexplogaddexp2logcumsumexplogical_andlogical_notlogical_orlogical_xorLogitOptionsLogNormalOptionsLogOptionslogsigmoidlogspacelogsumexpLogsumexpOptionsltLUShapeLuSolveOptionsmasked_fillmasked_selectmasked_select_asyncMaskSpecmatmulmatmul_error_inner_dimensions_do_not_matchMatmul2DShapeMatmulShapeMatmulShapeRuleMatrixTransposeShapemaxmaximummeanmedianmemory_statsmemory_summarymeshgridmethod_already_registered_errormethod_dtype_not_supported_errorMethodConfigMethodEntryMethodHandleminminimummishmmMMShapeRulemodemovedimmsortmulmultinomialmultinomial_asyncMultinomialAsyncOptionsMultinomialOptionsMultiplyBymvMVShapeRulenan_to_numnanmeannanmediannanquantileNanReductionOptionsnansumNanToNumOptionsnarrownarrow_copynarrow_error_length_exceeds_boundsnarrow_error_start_out_of_boundsNarrowShapeneneedsBroadcastnegNegativeDimnextafternonzeroNonzeroOptionsnormnormalNormalOptionsNormOptionsnumelonesones_likeop_kind_mismatch_errorop_not_found_errorOpCoverageEntryOpInfoOpKindOpNameOpSchemaOpSchemasouterOuterShapepackPackShapepermutepermute_error_dimension_count_mismatchPermuteShapepoissonpolarPool1dShapePool2dShapePool3dShapepositivepowpreluPrintOptionsprodprofiler_allow_cudagraph_cupti_lazy_reinit_cuda12promote_typesPromoteDTypeRulePutOptionsquantileQuantileOptionsrad2degrandrand_likerandintrandint_likeRandintLikeOptionsRandintOptionsrandnrandn_likeRandomLikeOptionsRandomOptionsrandpermRangeSpecRankravelrealrearrangeRearrangeOptionsRearrangeShapereciprocalreduceReduceOperationReduceOptionsReduceShapeReductionKernelConfigCPUReductionKernelCPUReductionOpNamesReductionOpSchemaReductionOptionsReductionShapeRuleregister_backwardregister_deviceregister_dtyperegister_forwardregister_functionregister_methodregister_scalar_forwardregisterAutogradRegisterBackwardOptionsregisterBinaryOpregisterDTypeRegisterDTypeOptionsRegisteredDTyperegisterFunctionRegisterFunctionOptionsregisterKernelRegisterKernelOptionsregisterMethodRegisterMethodOptionsregisterScalarKernelregisterUnaryOpregistration_failed_errorrelurelu_relu6ReluFunctionalOptionsremainderRemoveDimrepeatrepeat_interleaveRepeatInterleaveOptionsRepeatOptionsRepeatShapeReplaceDimrequireWebGPUreset_peak_memory_statsreshapeReshapeShaperesult_typerfftrollRollOptionsrot90Rot90Optionsroundrrelurrelu_RreluFunctionalOptionsrsqrtSafeExpandShapeSameDTypeRuleSameShapeRuleSaveForBackwardScalarCPUForwardFnScalarCPUKernelConfigScalarKernelEntryScalarKernelHandleScalarWebGPUKernelConfigScaleDimscatterscatter_addscatter_add_scatter_error_dim_out_of_rangescatter_reducescatter_reduce_ScatterReduceOptionsScatterShapesearchsortedSearchSortedOptionsselectselect_error_index_out_of_boundsselect_scatterSelectShapeseluset_default_deviceset_default_tensor_typeset_deterministic_debug_modeset_float32_matmul_precisionset_printoptionsset_warn_alwaysSetupContextFnShapeShapeCheckedResultShapedTensorShapeErrorMessageShapeOpSchemaShapeRulesigmoidsignsignbitsilusinsincsinhSizeOptionsslice_error_out_of_boundsslice_scatterSliceOptionsSliceScatterOptionsSliceShapeSliceSpecsoftmaxsoftmax_error_dim_out_of_rangeSoftmaxShapesoftminSoftminFunctionalOptionssoftplusSoftplusFunctionalOptionssoftshrinksoftsignsortSortOptionssplitsplit_error_dim_out_of_rangeSplitOptionssqrtsquaresqueezeSqueezeOptionsSqueezeShapestackStackOptionsStackShapestdstd_meanStdVarMeanOptionsStdVarOptionsstftSTFTOptionsStrideOptionssubSublistSublistElementSubscriptIndexsumSVDShapeswapaxessym_floatsym_intsym_notttaketake_along_dimTakeAlongDimOptionstantanhtanhshrinktensortensor_splitTensorCreatorTensorDatatensordotTensordotOptionsTensorLikeTensorMetaTensorOptionsTensorStoragethresholdthreshold_tileTileShapeToOptionstopkTopkOptionsTorchtraceTraceShapetransposetranspose_dims_error_out_of_rangetranspose_error_requires_2d_tensorTransposeDimsShapeTransposeDimsShapeCheckedTransposeShapetrapezoidTrapezoidOptionsTriangularOptionstriltril_indicesTriOptionsTripletriutriu_indicestrue_dividetruncTupleOfLengthTypedArrayTypedArrayForTypedStorageTypeOptionsUnaryBackwardFnUnaryDTypeUnaryKernelConfigCPUUnaryKernelCPUUnaryOpConfigUnaryOpFnUnaryOpNamesUnaryOpParamsUnaryOpSchemaUnaryOptionsunbindunbind_error_dim_out_of_rangeUnbindOptionsunflattenUniformOptionsuniqueunique_consecutiveUniqueConsecutiveOptionsUniqueOptionsunpackUnpackShapeunravel_indexunregister_deviceunsqueezeUnsqueezeOptionsUnsqueezeShapeuse_deterministic_algorithmsValidateBatchedSquareMatrixValidateChunkDimValidatedEinsumShapevalidateDeviceValidateDeviceValidatedRearrangeShapeValidatedReduceShapeValidatedRepeatShapevalidateDTypeValidateEinsumValidateOperandCountValidateRanksValidateScalarValidateSplitDimValidateSquareMatrixValidateUnbindDimValueOptionsvar_var_meanvdotviewview_as_complexview_as_realvmapvsplitvstackWebGPUKernelConfigWebGPUOnlyResultWebGPUTensorDatawhereWindowOptionsxlogyzeroszeros_like
torch.js· 2026
LegalTerms of UsePrivacy Policy
/
/
  1. docs
  2. torch.js
  3. torch
  4. linalg
  5. matrix_rank

torch.linalg.matrix_rank

function matrix_rank<S extends Shape, D extends DType, Dev extends DeviceType>(A: Tensor<S, D, Dev>, options?: MatrixRankOptions): Tensor<DynamicShape, 'int32', Dev>function matrix_rank<S extends Shape, D extends DType, Dev extends DeviceType>(A: Tensor<S, D, Dev>, atol: number, rtol: number, hermitian: boolean, options?: MatrixRankOptions): Tensor<DynamicShape, 'int32', Dev>

Computes the numerical rank of a matrix (number of independent rows/columns).

Rank measures the dimensionality of the data that can be expressed by the matrix. Essential for:

  • Detecting linearly dependent rows/columns
  • Assessing whether a system of equations is solvable
  • Determining effective dimensionality of data
  • Rank-deficiency detection in least squares problems
  • Deciding low-rank approximation strategies
  • Numerical stability assessment

Rank interpretation:

  • rank(A) = 0: Zero matrix (no information)
  • rank(A) = min(m, n): Full rank (no linear dependencies)
  • rank(A) < min(m, n): Rank-deficient (linear dependencies exist)

Numerical rank definition: Count of singular values σᵢ that satisfy σᵢ > threshold:

  • threshold = max(atol, rtol × σ_max)
  • If σᵢ > threshold: counts as non-zero
  • If σᵢ ≤ threshold: counts as negligible

Why numerical rank?

  • Exact rank is ill-defined due to rounding errors
  • Must distinguish "mathematically zero" from "numerically negligible"
  • Threshold parameters (atol, rtol) control the distinction
\begin{aligned} \\text{rank}(A) = \\#\\{i : \\sigma_i > \\max(\\text{atol}, \\text{rtol} \\times \\sigma_{\\max})\\} \\ \\text{Mathematical rank} \\leq \\text{numerical rank} \\leq \\min(m, n) \end{aligned}
  • Numerical vs mathematical rank: Numerical rank depends on tolerance; mathematical rank is exact
  • Default tolerances: rtol ≈ 1e-6 × min(m, n), sensible for most applications
  • atol vs rtol: atol for small singular values, rtol for relative scaling
  • Rectangular matrices OK: Works for any m × n, not just square
  • Hermitian fast path: Use hermitian=true for symmetric matrices (uses eigvalsh)
  • SVD-based: Uses singular values for robust rank computation
  • Batching supported: Works with batched input matrices
  • Tolerance sensitivity: Results depend on atol and rtol; choose carefully
  • Ill-conditioned matrices: Small singular values can be unreliable; use larger atol
  • Near-rank-deficiency: Matrices with many small singular values are numerically tricky

Parameters

ATensor<S, D, Dev>
Input matrix (m × n) or batch (..., m, n)
optionsMatrixRankOptionsoptional

Returns

Tensor<DynamicShape, 'int32', Dev>– Rank as scalar integer tensor or batch of integers

Examples

// Full rank matrix (no linear dependencies)
const A = torch.tensor([
  [1.0, 2.0],
  [3.0, 4.0]
]);
const rank = torch.linalg.matrix_rank(A);  // 2 (full rank)

// Rank-deficient matrix (dependent rows)
const B = torch.tensor([
  [1.0, 2.0],
  [2.0, 4.0]  // Second row = 2 × first row
]);
const rank = torch.linalg.matrix_rank(B);  // 1 (rank-deficient)

// Tall matrix with full column rank
const A = torch.randn(100, 50);  // 100 rows, 50 columns
const rank = torch.linalg.matrix_rank(A);  // Should be 50 (full column rank)

// Detecting when least squares is well-posed
const A = torch.randn(100, 20);  // 100 equations, 20 unknowns
const b = torch.randn(100);
const rank_A = torch.linalg.matrix_rank(A);
if (rank_A.item() === 20) {
  console.log('Full rank; least squares has unique minimum-norm solution');
} else {
  console.log('Rank-deficient; least squares solution not unique');
}

// Effective dimensionality of data matrix
const X = torch.randn(1000, 100);  // 1000 samples, 100 features
const rank_X = torch.linalg.matrix_rank(X);
console.log(`Data has effective dimensionality ${rank_X.item()}`);
// If rank < 100, data lies in lower-dimensional subspace

// Controlling tolerance for rank estimation
const A = torch.randn(10, 10);
const rank_strict = torch.linalg.matrix_rank(A, 1e-12, 0);  // Very strict
const rank_loose = torch.linalg.matrix_rank(A, 1e-6, 0);    // More lenient
// Stricter tolerance counts more singular values as non-zero

// Using symmetric matrix fast path
const S = torch.randn(5, 5);
const S_sym = S.add(S.T).mul(0.5);  // Symmetrize
const rank = torch.linalg.matrix_rank(S_sym, undefined, undefined, true);
// true = hermitian: uses eigvalsh instead of SVD (faster)

// Batched rank computation
const A_batch = torch.randn(32, 50, 30);  // 32 matrices
const ranks = torch.linalg.matrix_rank(A_batch);
// ranks shape: [32] - rank for each matrix

See Also

  • PyTorch torch.linalg.matrix_rank()
  • svdvals - Singular values (used internally for rank computation)
  • svd - Full singular value decomposition (to inspect singular values)
  • matrix_norm - Matrix norms (related to conditioning)
  • cond - Condition number (relates to near-rank-deficiency)
  • pinv - Pseudoinverse (uses rank-aware thresholding)
Previous
matrix_power
Next
MatrixNormOptions