HugeCTR API Documentation

• Python Interface
  • About the HugeCTR Python Interface
  • High-level Training API
    • Solver
      • CreateSolver method
      • CreateETC method
    • AsyncParam
      • AsyncParam class
    • HybridEmbeddingParam
      • HybridEmbeddingParam class
    • DataReaderParams
      • DataReaderParams class
    • Dataset formats
      • Norm
      • Raw
      • Parquet
    • OptParamsPy
      • CreateOptimizer method
  • Layers
    • Input Layer
    • SparseEmbedding
    • DenseLayer
    • GroupDenseLayer
    • Model
      • Model class
      • add method
      • compile method
      • fit method
      • summary method
      • graph_to_json method
      • construct_from_json method
      • load_dense_weights method
      • load_dense_optimizer_states method
      • load_sparse_weights method
      • load_sparse_optimizer_states method
      • freeze_dense method
      • freeze_embedding method
      • unfreeze_dense method
      • unfreeze_embedding method
      • reset_learning_rate_scheduler method
      • set_source method
  • Low-level Training API
    • LearningRateScheduler
      • get_next method
    • DataReader
      • set_source method
      • is_eof method
    • EmbeddingTraingCache
      • update method
    • Model
      • get_learning_rate_scheduler method
      • get_embedding_training_cache method
      • get_data_reader_train method
      • get_data_reader_eval method
      • start_data_reading method
      • set_learning_rate method
      • train method
      • get_current_loss method
      • eval method
      • get_eval_metrics method
      • get_incremental_model method
      • save_params_to_files method
      • export_predictions method
  • Inference API
    • InferenceParams
      • InferenceParams class
    • VolatileDatabaseParams
      • VolatileDatabaseParams class
    • PersistentDatabaseParams
      • PersistentDatabaseParams class
    • UpdateSourceParams
      • UpdateSourceParams class
    • InferenceModel
      • InferenceModel class
      • predict method
      • evaluate method
  • Data Generator API
    • DataGeneratorParams class
    • DataGenerator
      • DataGenerator class
      • generate method
  • Data Source API
    • DataSourceParams class
    • DataSource
      • DataSource class
      • move_to_local method
• Layer Classes and Methods
  • Input Layer
  • Sparse Embedding
  • Embedding Types Detail
    • DistributedSlotSparseEmbeddingHash Layer
    • LocalizedSlotSparseEmbeddingHash Layer
    • LocalizedSlotSparseEmbeddingOneHot Layer
  • Dense Layers
  • Dense Layers Usage
    • FullyConnected Layer
    • FusedFullyConnected Layer
    • MultiCross Layer
    • FmOrder2 Layer
    • WeightMultiply Layer
    • ElementwiseMultiply Layer
    • BatchNorm Layer
    • Concat Layer
    • Reshape Layer
    • Slice Layer
    • Dropout Layer
    • ELU Layer
    • ReLU Layer
    • Sigmoid Layer
    • Interaction Layer
    • Add Layer
    • ReduceSum Layer
      • GRU Layer
      • PReLUDice Layer
      • Scale Layer
      • FusedReshapeConcat Layer
      • FusedReshapeConcatGeneral Layer
      • Softmax Layer
      • Sub Layer
      • ReduceMean Layer
      • MatrixMutiply Layer
      • Gather Layer
    • BinaryCrossEntropyLoss
    • CrossEntropyLoss
    • MultiCrossEntropyLoss