cybench package

Subpackages

• cybench.datasets package
  • Submodules
  • cybench.datasets.alignment module
    • add_cutoff_days()
    • aggregate_time_series_data()
    • align_inputs_and_labels()
    • align_to_crop_season_window()
    • align_to_crop_season_window_numpy()
    • compute_crop_season_window()
    • ensure_same_categories_union()
    • interpolate_time_series_data()
    • interpolate_time_series_data_items()
    • process_crop_seasons()
    • restore_category_to_string()
  • cybench.datasets.configured module
    • DatasetVersionError
    • _load_and_preprocess_time_series_data()
    • load_dfs()
    • load_dfs_crop()
  • cybench.datasets.dataset module
    • Dataset
      • Dataset._empty_df_target()
      • Dataset._filter_df_on_index()
      • Dataset._get_feature_data()
      • Dataset._split_df_on_index()
      • Dataset._validate_dfs()
      • Dataset.crop
      • Dataset.feature_names
      • Dataset.get_normalization_params()
      • Dataset.indices()
      • Dataset.load()
      • Dataset.location_ids
      • Dataset.max_season_window_length
      • Dataset.split_on_years()
      • Dataset.targets()
      • Dataset.years
  • cybench.datasets.dataset_overview module
  • cybench.datasets.modified_dataset module
    • ModifiedTargetsDataset
  • cybench.datasets.torch_dataset module
    • TorchDataset
      • TorchDataset.cast_to_tensor()
      • TorchDataset.collate_fn()
      • TorchDataset.interpolate_and_aggregate()
  • Module contents
• cybench.evaluation package
  • Submodules
  • cybench.evaluation.eval module
    • evaluate_model()
    • evaluate_predictions()
    • get_default_metrics()
    • mape()
    • metric()
    • normalized_rmse()
    • prepare_targets_preds()
    • r()
    • r2()
  • cybench.evaluation.example_log_experiment module
  • cybench.evaluation.log_experiments module
    • comet_wrapper()
    • existing_comet()
    • get_comet_api_key()
    • log_benchmark_to_comet()
    • log_benchmark_to_comet_post_hoc()
    • log_to_comet_post_hoc()
  • Module contents
• cybench.models package
  • Submodules
  • cybench.models.model module
    • BaseModel
      • BaseModel._abc_impl
      • BaseModel.fit()
      • BaseModel.load()
      • BaseModel.predict()
      • BaseModel.predict_items()
      • BaseModel.save()
  • cybench.models.naive_models module
    • AverageYieldModel
      • AverageYieldModel._abc_impl
      • AverageYieldModel.fit()
      • AverageYieldModel.load()
      • AverageYieldModel.predict_items()
      • AverageYieldModel.save()
  • cybench.models.nn_models module
    • BaseNNModel
      • BaseNNModel._abc_impl
      • BaseNNModel._forward_pass()
      • BaseNNModel._normalize_inputs()
      • BaseNNModel._optimize_hyperparameters()
      • BaseNNModel._train_and_validate()
      • BaseNNModel._train_epoch()
      • BaseNNModel._train_final_model()
      • BaseNNModel.fit()
      • BaseNNModel.load()
      • BaseNNModel.predict()
      • BaseNNModel.predict_items()
      • BaseNNModel.save()
    • BaselineInceptionTime
      • BaselineInceptionTime._abc_impl
      • BaselineInceptionTime.fit()
      • BaselineInceptionTime.forward()
    • BaselineLSTM
      • BaselineLSTM._abc_impl
      • BaselineLSTM.fit()
      • BaselineLSTM.forward()
    • BaselineTransformer
      • BaselineTransformer._abc_impl
      • BaselineTransformer.fit()
      • BaselineTransformer.forward()
    • separate_ts_static_inputs()
  • cybench.models.residual_models module
    • InceptionTimeRes
      • InceptionTimeRes._abc_impl
    • LSTMRes
      • LSTMRes._abc_impl
    • RandomForestRes
      • RandomForestRes._abc_impl
    • ResidualModel
      • ResidualModel._abc_impl
      • ResidualModel.fit()
      • ResidualModel.load()
      • ResidualModel.predict()
      • ResidualModel.predict_items()
      • ResidualModel.save()
    • RidgeRes
      • RidgeRes._abc_impl
    • TransformerRes
      • TransformerRes._abc_impl
  • cybench.models.sklearn_models module
    • BaseSklearnModel
      • BaseSklearnModel._abc_impl
      • BaseSklearnModel._design_features()
      • BaseSklearnModel._optimize_hyperparameters()
      • BaseSklearnModel._predict()
      • BaseSklearnModel.fit()
      • BaseSklearnModel.load()
      • BaseSklearnModel.predict()
      • BaseSklearnModel.predict_items()
      • BaseSklearnModel.save()
    • SklearnRandomForest
      • SklearnRandomForest._abc_impl
      • SklearnRandomForest.fit()
    • SklearnRidge
      • SklearnRidge._abc_impl
      • SklearnRidge.fit()
  • cybench.models.trend_models module
    • TrendModel
      • TrendModel.MAX_TREND_WINDOW_SIZE
      • TrendModel.MIN_TREND_WINDOW_SIZE
      • TrendModel._abc_impl
      • TrendModel._estimate_trend()
      • TrendModel._find_optimal_trend_window()
      • TrendModel._predict_trend()
      • TrendModel.fit()
      • TrendModel.load()
      • TrendModel.predict()
      • TrendModel.predict_items()
      • TrendModel.save()
  • Module contents
• cybench.runs package
  • Submodules
  • cybench.runs.agml_workshop module
    • LSTMModel
      • LSTMModel._abc_impl
      • LSTMModel._get_validation_splits()
      • LSTMModel._optimize_hyperparameters()
      • LSTMModel._train_epoch()
      • LSTMModel.fit()
      • LSTMModel.forward()
      • LSTMModel.load()
      • LSTMModel.predict()
      • LSTMModel.predict_items()
      • LSTMModel.save()
    • date_from_dekad()
    • get_cybench_data()
    • get_cybench_data_aligned_to_crop_season()
    • get_workshop_data()
    • validate_agml_workshop_results()
  • cybench.runs.benchmark_summary module
    • dataset_summary()
    • run_benchmark_summary()
  • cybench.runs.process_results module
    • df_to_markdown()
    • format_row()
    • results_to_metrics()
    • results_to_residuals()
    • write_results_to_table()
  • cybench.runs.results_plots module
    • box_plots_metrics()
    • box_plots_residuals()
    • plot_bars()
    • plot_graph()
    • plot_metrics()
    • plot_yearly_metrics()
    • plot_yearly_residuals()
  • cybench.runs.run_benchmark module
    • compute_metrics()
    • get_prediction_residuals()
    • load_results()
    • run_benchmark()
    • run_benchmark_on_all_data()
  • cybench.runs.visualize_results module
    • deduce_crop_country_from_filename()
    • plot_results_summary()
  • Module contents
• cybench.util package
  • Submodules
  • cybench.util.data module
    • data_to_pandas()
    • trim_time_series_data()
  • cybench.util.features module
    • _add_period()
    • _aggregate_by_period()
    • _count_threshold()
    • dekad_from_date()
    • design_features()
    • fortnight_from_date()
    • growing_degree_days()
    • unpack_time_series()
  • cybench.util.geo module
    • get_shapes_from_polygons()
  • cybench.util.torch module
    • batch_tensors()
  • Module contents

Submodules

cybench.config module

Module contents