mirrors/pytorch
0
0 Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2026-10-28 18:56:51 +08:00
Code Activity
Files
main
pytorch/docs/cpp/cpp_coverage.txt
T
Svetlana Karslioglu 19da3da3d3 Restructure C++ docs (#174096) 
The fix-cpp-build branch is a major restructuring that:

- Drops Exhale (which auto-generated API docs but caused OOM in CI) in favor of hand-written RST pages using Breathe directives
- Reorganizes notes into a hierarchical API reference with proper categories
- Adds new content: XPU docs, stable ABI docs, DeviceGuard/Stream docs
- Always runs Doxygen instead of gating on an env var

Pull Request resolved: https://github.com/pytorch/pytorch/pull/174096
Approved by: https://github.com/janeyx99, https://github.com/seemethere, https://github.com/albanD
2026-04-07 17:24:38 +00:00

293 lines
12 KiB
Plaintext
Raw Permalink Blame History

Undocumented C++ objects
==================================================
torch (device)
--------------
* torch::cuda::device_count (function)
* torch::cuda::is_available (function)
* torch::cuda::manual_seed (function)
* torch::cuda::manual_seed_all (function)
* torch::cuda::synchronize (function)
* torch::mps::commit (function)
* torch::mps::get_command_buffer (function)
* torch::mps::get_dispatch_queue (function)
* torch::mps::is_available (function)
* torch::mps::manual_seed (function)
* torch::mps::synchronize (function)
torch (macros)
--------------
* TORCH_MODULE (define)
* TORCH_MODULE_IMPL (define)
torch::data
-----------
* torch::data::datasets::ChunkDatasetOptions (struct)
* torch::data::datasets::TensorDataset (struct)
* torch::data::make_data_loader (function)
* torch::data::samplers::BatchSize (struct)
* torch::data::samplers::CustomBatchRequest (struct)
torch::fft
----------
* torch::fft::fft (function)
* torch::fft::fft2 (function)
* torch::fft::fftfreq (function)
* torch::fft::fftn (function)
* torch::fft::fftshift (function)
* torch::fft::hfft (function)
* torch::fft::hfft2 (function)
* torch::fft::hfftn (function)
* torch::fft::ifft (function)
* torch::fft::ifft2 (function)
* torch::fft::ifftn (function)
* torch::fft::ifftshift (function)
* torch::fft::ihfft (function)
* torch::fft::ihfft2 (function)
* torch::fft::ihfftn (function)
* torch::fft::irfft (function)
* torch::fft::irfft2 (function)
* torch::fft::irfftn (function)
* torch::fft::rfft (function)
* torch::fft::rfft2 (function)
* torch::fft::rfftfreq (function)
* torch::fft::rfftn (function)
torch::nn (modules)
-------------------
* torch::nn::AdaptiveAvgPoolOptions (struct)
* torch::nn::AdaptiveMaxPoolOptions (struct)
* torch::nn::AvgPoolOptions (struct)
* torch::nn::BatchNormOptions (struct)
* torch::nn::BilinearOptions (struct)
* torch::nn::CELUOptions (struct)
* torch::nn::ConstantPad1dImpl (class)
* torch::nn::ConstantPad2dImpl (class)
* torch::nn::ConstantPad3dImpl (class)
* torch::nn::ConstantPadOptions (struct)
* torch::nn::ConvOptions (struct)
* torch::nn::ConvTransposeOptions (struct)
* torch::nn::CosineSimilarityImpl (class)
* torch::nn::CosineSimilarityOptions (struct)
* torch::nn::DropoutOptions (struct)
* torch::nn::ELUOptions (struct)
* torch::nn::EmbeddingBagFromPretrainedOptions (struct)
* torch::nn::EmbeddingBagOptions (struct)
* torch::nn::EmbeddingFromPretrainedOptions (struct)
* torch::nn::EmbeddingOptions (struct)
* torch::nn::FlattenOptions (struct)
* torch::nn::FoldImpl (class)
* torch::nn::FractionalMaxPoolOptions (struct)
* torch::nn::Functional (class)
* torch::nn::GELUOptions (struct)
* torch::nn::GLUOptions (struct)
* torch::nn::HardshrinkOptions (struct)
* torch::nn::HardtanhOptions (struct)
* torch::nn::InstanceNormOptions (struct)
* torch::nn::KLDivLossOptions (struct)
* torch::nn::L1LossOptions (struct)
* torch::nn::LPPoolOptions (struct)
* torch::nn::LayerNormOptions (struct)
* torch::nn::LeakyReLUOptions (struct)
* torch::nn::LinearOptions (struct)
* torch::nn::LogSoftmaxOptions (struct)
* torch::nn::MaxPoolOptions (struct)
* torch::nn::MaxUnpoolOptions (struct)
* torch::nn::ModuleDictImpl (class)
* torch::nn::ModuleListImpl (class)
* torch::nn::MultiheadAttentionOptions (struct)
* torch::nn::PReLUOptions (struct)
* torch::nn::PairwiseDistanceImpl (class)
* torch::nn::PairwiseDistanceOptions (struct)
* torch::nn::PixelShuffleImpl (struct)
* torch::nn::PixelUnshuffleImpl (struct)
* torch::nn::RNNOptions (struct)
* torch::nn::RReLUOptions (struct)
* torch::nn::ReLU6Options (struct)
* torch::nn::ReLUOptions (struct)
* torch::nn::ReflectionPad1dImpl (class)
* torch::nn::ReflectionPad2dImpl (class)
* torch::nn::ReflectionPad3dImpl (class)
* torch::nn::ReflectionPadOptions (struct)
* torch::nn::ReplicationPad1dImpl (class)
* torch::nn::ReplicationPad2dImpl (class)
* torch::nn::ReplicationPad3dImpl (class)
* torch::nn::ReplicationPadOptions (struct)
* torch::nn::SELUOptions (struct)
* torch::nn::SequentialImpl (class)
* torch::nn::SoftmaxOptions (struct)
* torch::nn::SoftminOptions (struct)
* torch::nn::SoftplusOptions (struct)
* torch::nn::SoftshrinkOptions (struct)
* torch::nn::ThresholdOptions (struct)
* torch::nn::TransformerDecoderOptions (struct)
* torch::nn::TransformerEncoderLayerOptions (struct)
* torch::nn::TransformerEncoderOptions (struct)
* torch::nn::TransformerOptions (struct)
* torch::nn::UnflattenOptions (struct)
* torch::nn::UnfoldImpl (class)
* torch::nn::UpsampleImpl (class)
* torch::nn::ZeroPad1dImpl (class)
* torch::nn::ZeroPad2dImpl (class)
* torch::nn::ZeroPad3dImpl (class)
* torch::nn::ZeroPadOptions (struct)
torch::nn::functional
---------------------
* torch::nn::functional::AlphaDropoutFuncOptions (struct)
* torch::nn::functional::BatchNormFuncOptions (struct)
* torch::nn::functional::ConvFuncOptions (struct)
* torch::nn::functional::ConvTransposeFuncOptions (struct)
* torch::nn::functional::DropoutFuncOptions (struct)
* torch::nn::functional::EmbeddingBagFuncOptions (struct)
* torch::nn::functional::EmbeddingFuncOptions (struct)
* torch::nn::functional::FeatureAlphaDropoutFuncOptions (struct)
* torch::nn::functional::GridSampleFuncOptions (struct)
* torch::nn::functional::GumbelSoftmaxFuncOptions (struct)
* torch::nn::functional::InstanceNormFuncOptions (struct)
* torch::nn::functional::InterpolateFuncOptions (struct)
* torch::nn::functional::LogSoftmaxFuncOptions (struct)
* torch::nn::functional::MaxUnpoolFuncOptions (struct)
* torch::nn::functional::MultiheadAttentionForwardFuncOptions (struct)
* torch::nn::functional::PadFuncOptions (struct)
* torch::nn::functional::RReLUFuncOptions (struct)
* torch::nn::functional::SoftmaxFuncOptions (struct)
* torch::nn::functional::SoftminFuncOptions (struct)
* torch::nn::functional::adaptive_max_pool2d_with_indices (function)
* torch::nn::functional::adaptive_max_pool3d_with_indices (function)
* torch::nn::functional::fractional_max_pool2d_with_indices (function)
* torch::nn::functional::fractional_max_pool3d_with_indices (function)
* torch::nn::functional::multi_head_attention_forward (function)
torch::nn::init
---------------
* torch::nn::init::calculate_gain (function)
* torch::nn::init::constant_ (function)
* torch::nn::init::dirac_ (function)
* torch::nn::init::eye_ (function)
* torch::nn::init::kaiming_normal_ (function)
* torch::nn::init::kaiming_uniform_ (function)
* torch::nn::init::normal_ (function)
* torch::nn::init::ones_ (function)
* torch::nn::init::orthogonal_ (function)
* torch::nn::init::sparse_ (function)
* torch::nn::init::uniform_ (function)
* torch::nn::init::xavier_normal_ (function)
* torch::nn::init::xavier_uniform_ (function)
* torch::nn::init::zeros_ (function)
torch::nn::utils
----------------
* torch::nn::utils::clip_grad_norm_ (function)
* torch::nn::utils::clip_grad_value_ (function)
* torch::nn::utils::parameters_to_vector (function)
* torch::nn::utils::rnn::invert_permutation (function)
* torch::nn::utils::vector_to_parameters (function)
torch::optim
------------
* torch::optim::AdagradOptions (struct)
* torch::optim::AdagradParamState (struct)
* torch::optim::AdamOptions (struct)
* torch::optim::AdamParamState (struct)
* torch::optim::AdamWOptions (struct)
* torch::optim::AdamWParamState (struct)
* torch::optim::LBFGSOptions (struct)
* torch::optim::LBFGSParamState (struct)
* torch::optim::RMSpropOptions (struct)
* torch::optim::RMSpropParamState (struct)
* torch::optim::SGDOptions (struct)
* torch::optim::SGDParamState (struct)
torch::special
--------------
* torch::special::airy_ai (function)
* torch::special::bessel_j0 (function)
* torch::special::bessel_j1 (function)
* torch::special::bessel_y0 (function)
* torch::special::bessel_y1 (function)
* torch::special::chebyshev_polynomial_t (function)
* torch::special::chebyshev_polynomial_u (function)
* torch::special::chebyshev_polynomial_v (function)
* torch::special::chebyshev_polynomial_w (function)
* torch::special::digamma (function)
* torch::special::entr (function)
* torch::special::erf (function)
* torch::special::erfc (function)
* torch::special::erfcx (function)
* torch::special::erfinv (function)
* torch::special::exp2 (function)
* torch::special::expit (function)
* torch::special::expm1 (function)
* torch::special::gammainc (function)
* torch::special::gammaincc (function)
* torch::special::gammaln (function)
* torch::special::hermite_polynomial_h (function)
* torch::special::hermite_polynomial_he (function)
* torch::special::i0 (function)
* torch::special::i0e (function)
* torch::special::i1 (function)
* torch::special::i1e (function)
* torch::special::laguerre_polynomial_l (function)
* torch::special::legendre_polynomial_p (function)
* torch::special::log1p (function)
* torch::special::log_ndtr (function)
* torch::special::log_softmax (function)
* torch::special::logit (function)
* torch::special::logsumexp (function)
* torch::special::modified_bessel_i0 (function)
* torch::special::modified_bessel_i1 (function)
* torch::special::modified_bessel_k0 (function)
* torch::special::modified_bessel_k1 (function)
* torch::special::multigammaln (function)
* torch::special::ndtr (function)
* torch::special::ndtri (function)
* torch::special::polygamma (function)
* torch::special::psi (function)
* torch::special::round (function)
* torch::special::scaled_modified_bessel_k0 (function)
* torch::special::scaled_modified_bessel_k1 (function)
* torch::special::shifted_chebyshev_polynomial_t (function)
* torch::special::shifted_chebyshev_polynomial_u (function)
* torch::special::shifted_chebyshev_polynomial_v (function)
* torch::special::shifted_chebyshev_polynomial_w (function)
* torch::special::sinc (function)
* torch::special::softmax (function)
* torch::special::spherical_bessel_j0 (function)
* torch::special::xlog1py (function)
* torch::special::xlogy (function)
* torch::special::zeta (function)
==================================================
Summary
==================================================
Total APIs discovered: 699
Documented: 472
Missing: 227
Coverage: 67.5%
Category Covered Total %
----------------------------------------------------------------------
at 4 4 100.0%
at::cuda 7 7 100.0%
c10 10 10 100.0%
c10::cuda 9 9 100.0%
c10::xpu 4 4 100.0%
other 1 1 100.0%
torch (core) 4 4 100.0%
torch (device) 5 16 31.2%
torch (macros) 3 5 60.0%
torch::autograd 3 3 100.0%
torch::data 29 34 85.3%
torch::fft 0 22 0.0%
torch::nn (modules) 243 319 76.2%
torch::nn::functional 100 124 80.6%
torch::nn::init 0 14 0.0%
torch::nn::utils 0 5 0.0%
torch::optim 13 25 52.0%
torch::serialize 4 4 100.0%
torch::special 0 56 0.0%
torch::stable 33 33 100.0%
View Git Blame Copy Permalink