RecBole

Get Started

  • Install RecBole
  • Quick Start
  • Distributed Training

User Guide

  • Config Introduction
  • Data Module Introduction
  • Model Introduction
  • Training & Evaluation Introduction
  • Usage
    • Use run_recbole
    • Use Modules
    • Parameter Tuning
    • Running New Dataset
    • Running Different Models
    • Load Pre-trained Embedding
    • Save and load data and model
    • Case study
    • Use Tensorboard
    • Use Weights & Biases
    • Clarifications on some practical issues
    • Significance Test
    • Use run_recbole_group

Developer Guide

  • Customize Models
  • Customize Trainers
  • Customize DataLoaders
  • Customize Samplers
  • Customize Metrics

API REFERENCE:

  • recbole.config.configurator
  • Config
  • recbole.data
  • recbole.evaluator
  • recbole.model
  • recbole.quick_start
  • load_data_and_model()
  • objective_function()
  • run()
  • run_recbole()
  • run_recboles()
  • recbole.sampler
  • AbstractSampler
  • KGSampler
  • RepeatableSampler
  • Sampler
  • SeqSampler
  • recbole.trainer.hyper_tuning
  • ExhaustiveSearchError
  • HyperTuning
  • exhaustive_search()
  • recbole.trainer.trainer
  • AbstractTrainer
  • DecisionTreeTrainer
  • KGATTrainer
  • KGTrainer
  • LightGBMTrainer
  • MKRTrainer
  • NCLTrainer
  • PretrainTrainer
  • RaCTTrainer
  • RecVAETrainer
  • S3RecTrainer
  • TraditionalTrainer
  • Trainer
  • XGBoostTrainer
  • recbole.utils.case_study
  • full_sort_scores()
  • full_sort_topk()
  • recbole.utils.enum_type
  • EvaluatorType
  • FeatureSource
  • FeatureType
  • InputType
  • KGDataLoaderState
  • ModelType
  • recbole.utils.logger
  • RemoveColorFilter
  • init_logger()
  • set_color()
  • recbole.utils.utils
  • calculate_valid_score()
  • dict2str()
  • early_stopping()
  • ensure_dir()
  • get_environment()
  • get_flops()
  • get_gpu_usage()
  • get_local_time()
  • get_model()
  • get_tensorboard()
  • get_trainer()
  • init_seed()
  • list_to_latex()
RecBole
  • Usage
  • View page source

Usage¶

In order to help users learn the depth usage of RecBole, we write the following usage docs to give a detailed introduction about RecBole’s features.

  • Use run_recbole
  • Use Modules
  • Parameter Tuning
  • Running New Dataset
  • Running Different Models
  • Load Pre-trained Embedding
  • Save and load data and model
  • Case study
  • Use Tensorboard
  • Use Weights & Biases
  • Clarifications on some practical issues
  • Significance Test
  • Use run_recbole_group
Previous Next

© Copyright 2020-2025, RecBole Contributors.

Built with Sphinx using a theme provided by Read the Docs.