mkdocs.yml

# Project information
site_name: River
site_description: Online machine learning in Python
site_author: The Fellowship of Online Machine Learning
site_url: https://riverml.xyz
docs_dir: docs/linkified

# Repository
repo_name: online-ml/river
repo_url: https://github.com/online-ml/river
edit_uri: ""

# Copyright
copyright: Copyright © 2019 - 2026

# Navigation
nav:
  - Introduction:
    - introduction/installation.md
    - introduction/basic-concepts.md
    - Getting started:
      - introduction/getting-started/index.md
      - introduction/getting-started/binary-classification.md
      - introduction/getting-started/concept-drift-detection.md
      - introduction/getting-started/multiclass-classification.md
      - introduction/getting-started/regression.md
    - introduction/why-use-river.md
    - introduction/next-steps.md
    - introduction/related-projects.md
  - Recipes:
    - recipes/reading-data.md
    - recipes/model-evaluation.md
    - recipes/pipelines.md
    - recipes/feature-extraction.md
    - recipes/saving-loading.md
    - recipes/mini-batching.md
    - recipes/active-learning.md
    - recipes/bandits-101.md
    - recipes/cloning-and-mutating.md
    - recipes/rolling-computations.md
  - API:
    - api/overview.md
    - active:
      - api/active/EntropySampler.md
      - base:
        - api/active/base/ActiveLearningClassifier.md
    - anomaly:
      - api/anomaly/GaussianScorer.md
      - api/anomaly/HalfSpaceTrees.md
      - api/anomaly/LODA.md
      - api/anomaly/LocalOutlierFactor.md
      - api/anomaly/OneClassSVM.md
      - api/anomaly/PredictiveAnomalyDetection.md
      - api/anomaly/QuantileFilter.md
      - api/anomaly/StandardAbsoluteDeviation.md
      - api/anomaly/ThresholdFilter.md
      - base:
        - api/anomaly/base/AnomalyDetector.md
        - api/anomaly/base/AnomalyFilter.md
        - api/anomaly/base/SupervisedAnomalyDetector.md
    - bandit:
      - api/bandit/BayesUCB.md
      - api/bandit/EpsilonGreedy.md
      - api/bandit/Exp3.md
      - api/bandit/LinUCBDisjoint.md
      - api/bandit/RandomPolicy.md
      - api/bandit/ThompsonSampling.md
      - api/bandit/UCB.md
      - api/bandit/evaluate.md
      - api/bandit/evaluate-offline.md
      - base:
        - api/bandit/base/ContextualPolicy.md
        - api/bandit/base/Policy.md
      - datasets:
        - api/bandit/datasets/BanditDataset.md
        - api/bandit/datasets/NewsArticles.md
      - envs:
        - api/bandit/envs/CandyCaneContest.md
        - api/bandit/envs/KArmedTestbed.md
    - base:
      - api/base/Base.md
      - api/base/BaseTransformer.md
      - api/base/BinaryDriftAndWarningDetector.md
      - api/base/BinaryDriftDetector.md
      - api/base/Classifier.md
      - api/base/Clusterer.md
      - api/base/DriftAndWarningDetector.md
      - api/base/DriftDetector.md
      - api/base/Ensemble.md
      - api/base/Estimator.md
      - api/base/MiniBatchClassifier.md
      - api/base/MiniBatchRegressor.md
      - api/base/MiniBatchSupervisedTransformer.md
      - api/base/MiniBatchTransformer.md
      - api/base/MultiLabelClassifier.md
      - api/base/MultiTargetRegressor.md
      - api/base/Regressor.md
      - api/base/SupervisedTransformer.md
      - api/base/Transformer.md
      - api/base/Wrapper.md
      - api/base/WrapperEnsemble.md
    - cluster:
      - api/cluster/CluStream.md
      - api/cluster/DBSTREAM.md
      - api/cluster/DenStream.md
      - api/cluster/KMeans.md
      - api/cluster/ODAC.md
      - api/cluster/STREAMKMeans.md
      - api/cluster/TextClust.md
    - compat:
      - api/compat/River2SKLClassifier.md
      - api/compat/River2SKLClusterer.md
      - api/compat/River2SKLRegressor.md
      - api/compat/River2SKLTransformer.md
      - api/compat/SKL2RiverClassifier.md
      - api/compat/SKL2RiverRegressor.md
      - api/compat/convert-river-to-sklearn.md
      - api/compat/convert-sklearn-to-river.md
    - compose:
      - api/compose/Discard.md
      - api/compose/FuncTransformer.md
      - api/compose/Grouper.md
      - api/compose/Pipeline.md
      - api/compose/Prefixer.md
      - api/compose/Renamer.md
      - api/compose/Select.md
      - api/compose/SelectType.md
      - api/compose/Suffixer.md
      - api/compose/TargetTransformRegressor.md
      - api/compose/TransformerProduct.md
      - api/compose/TransformerUnion.md
      - api/compose/learn-during-predict.md
    - conf:
      - api/conf/Interval.md
      - api/conf/RegressionJackknife.md
    - covariance:
      - api/covariance/EmpiricalCovariance.md
      - api/covariance/EmpiricalPrecision.md
      - api/covariance/EwaCovariance.md
      - api/covariance/EwaPrecision.md
      - api/covariance/LedoitWolfCovariance.md
      - api/covariance/OASCovariance.md
      - api/covariance/ShrunkCovariance.md
    - datasets:
      - api/datasets/AirlinePassengers.md
      - api/datasets/BETH.md
      - api/datasets/Bananas.md
      - api/datasets/Bikes.md
      - api/datasets/ChickWeights.md
      - api/datasets/CreditCard.md
      - api/datasets/CriteoAds.md
      - api/datasets/Elec2.md
      - api/datasets/HTTP.md
      - api/datasets/Higgs.md
      - api/datasets/ImageSegments.md
      - api/datasets/Insects.md
      - api/datasets/Keystroke.md
      - api/datasets/MaliciousURL.md
      - api/datasets/MovieLens100K.md
      - api/datasets/Music.md
      - api/datasets/Phishing.md
      - api/datasets/Restaurants.md
      - api/datasets/SMSSpam.md
      - api/datasets/SMTP.md
      - api/datasets/SP500Stocks.md
      - api/datasets/Shuttle.md
      - api/datasets/SolarFlare.md
      - api/datasets/TREC07.md
      - api/datasets/Taxis.md
      - api/datasets/TrumpApproval.md
      - api/datasets/WaterFlow.md
      - api/datasets/WebTraffic.md
      - api/datasets/Yeast.md
      - base:
        - api/datasets/base/Dataset.md
        - api/datasets/base/FileDataset.md
        - api/datasets/base/RemoteDataset.md
        - api/datasets/base/SyntheticDataset.md
      - synth:
        - api/datasets/synth/Agrawal.md
        - api/datasets/synth/AnomalySine.md
        - api/datasets/synth/ConceptDriftStream.md
        - api/datasets/synth/Friedman.md
        - api/datasets/synth/FriedmanDrift.md
        - api/datasets/synth/Hyperplane.md
        - api/datasets/synth/LED.md
        - api/datasets/synth/LEDDrift.md
        - api/datasets/synth/Logical.md
        - api/datasets/synth/Mixed.md
        - api/datasets/synth/Mv.md
        - api/datasets/synth/Planes2D.md
        - api/datasets/synth/RandomRBF.md
        - api/datasets/synth/RandomRBFDrift.md
        - api/datasets/synth/RandomTree.md
        - api/datasets/synth/SEA.md
        - api/datasets/synth/STAGGER.md
        - api/datasets/synth/Sine.md
        - api/datasets/synth/Waveform.md
    - drift:
      - api/drift/ADWIN.md
      - api/drift/DriftRetrainingClassifier.md
      - api/drift/DummyDriftDetector.md
      - api/drift/KSWIN.md
      - api/drift/NoDrift.md
      - api/drift/PageHinkley.md
      - binary:
        - api/drift/binary/DDM.md
        - api/drift/binary/EDDM.md
        - api/drift/binary/FHDDM.md
        - api/drift/binary/HDDMA.md
        - api/drift/binary/HDDMW.md
      - datasets:
        - api/drift/datasets/AirlinePassengers.md
        - api/drift/datasets/Apple.md
        - api/drift/datasets/Bitcoin.md
        - api/drift/datasets/BrentSpotPrice.md
        - api/drift/datasets/Occupancy.md
        - api/drift/datasets/RunLog.md
        - api/drift/datasets/UKCoalEmploy.md
    - dummy:
      - api/dummy/NoChangeClassifier.md
      - api/dummy/PriorClassifier.md
      - api/dummy/StatisticRegressor.md
    - ensemble:
      - api/ensemble/ADWINBaggingClassifier.md
      - api/ensemble/ADWINBoostingClassifier.md
      - api/ensemble/AdaBoostClassifier.md
      - api/ensemble/BOLEClassifier.md
      - api/ensemble/BaggingClassifier.md
      - api/ensemble/BaggingRegressor.md
      - api/ensemble/EWARegressor.md
      - api/ensemble/LeveragingBaggingClassifier.md
      - api/ensemble/SRPClassifier.md
      - api/ensemble/SRPRegressor.md
      - api/ensemble/StackingClassifier.md
      - api/ensemble/VotingClassifier.md
    - evaluate:
      - api/evaluate/BinaryClassificationTrack.md
      - api/evaluate/ForecastingTrack.md
      - api/evaluate/MultiClassClassificationTrack.md
      - api/evaluate/RegressionTrack.md
      - api/evaluate/Track.md
      - api/evaluate/evaluate.md
      - api/evaluate/iter-evaluate.md
      - api/evaluate/iter-progressive-val-score.md
      - api/evaluate/progressive-val-score.md
    - facto:
      - api/facto/FFMClassifier.md
      - api/facto/FFMRegressor.md
      - api/facto/FMClassifier.md
      - api/facto/FMRegressor.md
      - api/facto/FwFMClassifier.md
      - api/facto/FwFMRegressor.md
      - api/facto/HOFMClassifier.md
      - api/facto/HOFMRegressor.md
    - feature_extraction:
      - api/feature-extraction/Agg.md
      - api/feature-extraction/BagOfWords.md
      - api/feature-extraction/PolynomialExtender.md
      - api/feature-extraction/RBFSampler.md
      - api/feature-extraction/RandomTreesEmbedding.md
      - api/feature-extraction/TFIDF.md
      - api/feature-extraction/TargetAgg.md
    - feature_selection:
      - api/feature-selection/PoissonInclusion.md
      - api/feature-selection/SelectKBest.md
      - api/feature-selection/VarianceThreshold.md
    - forest:
      - api/forest/AMFClassifier.md
      - api/forest/AMFRegressor.md
      - api/forest/ARFClassifier.md
      - api/forest/ARFRegressor.md
      - api/forest/OXTRegressor.md
    - imblearn:
      - api/imblearn/ChebyshevOverSampler.md
      - api/imblearn/ChebyshevUnderSampler.md
      - api/imblearn/HardSamplingClassifier.md
      - api/imblearn/HardSamplingRegressor.md
      - api/imblearn/RandomOverSampler.md
      - api/imblearn/RandomSampler.md
      - api/imblearn/RandomUnderSampler.md
    - linear_model:
      - api/linear-model/ALMAClassifier.md
      - api/linear-model/AdPredictor.md
      - api/linear-model/BayesianLinearRegression.md
      - api/linear-model/LinearRegression.md
      - api/linear-model/LogisticRegression.md
      - api/linear-model/PAClassifier.md
      - api/linear-model/PARegressor.md
      - api/linear-model/Perceptron.md
      - api/linear-model/SoftmaxRegression.md
      - base:
        - api/linear-model/base/GLM.md
    - metrics:
      - api/metrics/Accuracy.md
      - api/metrics/AdjustedMutualInfo.md
      - api/metrics/AdjustedRand.md
      - api/metrics/BalancedAccuracy.md
      - api/metrics/ClassificationReport.md
      - api/metrics/CohenKappa.md
      - api/metrics/Completeness.md
      - api/metrics/ConfusionMatrix.md
      - api/metrics/CrossEntropy.md
      - api/metrics/F1.md
      - api/metrics/FBeta.md
      - api/metrics/FowlkesMallows.md
      - api/metrics/GeometricMean.md
      - api/metrics/Homogeneity.md
      - api/metrics/Jaccard.md
      - api/metrics/LogLoss.md
      - api/metrics/MAE.md
      - api/metrics/MAPE.md
      - api/metrics/MCC.md
      - api/metrics/MSE.md
      - api/metrics/MacroF1.md
      - api/metrics/MacroFBeta.md
      - api/metrics/MacroJaccard.md
      - api/metrics/MacroPrecision.md
      - api/metrics/MacroRecall.md
      - api/metrics/MicroF1.md
      - api/metrics/MicroFBeta.md
      - api/metrics/MicroJaccard.md
      - api/metrics/MicroPrecision.md
      - api/metrics/MicroRecall.md
      - api/metrics/MultiFBeta.md
      - api/metrics/MutualInfo.md
      - api/metrics/NormalizedMutualInfo.md
      - api/metrics/Precision.md
      - api/metrics/R2.md
      - api/metrics/RMSE.md
      - api/metrics/RMSLE.md
      - api/metrics/ROCAUC.md
      - api/metrics/Rand.md
      - api/metrics/Recall.md
      - api/metrics/RollingPRAUC.md
      - api/metrics/RollingROCAUC.md
      - api/metrics/SMAPE.md
      - api/metrics/Silhouette.md
      - api/metrics/VBeta.md
      - api/metrics/WeightedF1.md
      - api/metrics/WeightedFBeta.md
      - api/metrics/WeightedJaccard.md
      - api/metrics/WeightedPrecision.md
      - api/metrics/WeightedRecall.md
      - base:
        - api/metrics/base/BinaryMetric.md
        - api/metrics/base/ClassificationMetric.md
        - api/metrics/base/Metric.md
        - api/metrics/base/Metrics.md
        - api/metrics/base/MultiClassMetric.md
        - api/metrics/base/RegressionMetric.md
        - api/metrics/base/WrapperMetric.md
      - multioutput:
        - api/metrics/multioutput/ExactMatch.md
        - api/metrics/multioutput/MacroAverage.md
        - api/metrics/multioutput/MicroAverage.md
        - api/metrics/multioutput/MultiLabelConfusionMatrix.md
        - api/metrics/multioutput/PerOutput.md
        - api/metrics/multioutput/SampleAverage.md
        - base:
          - api/metrics/multioutput/base/MultiOutputClassificationMetric.md
          - api/metrics/multioutput/base/MultiOutputRegressionMetric.md
    - misc:
      - api/misc/SDFT.md
      - api/misc/Skyline.md
      - api/misc/ZstdClassifier.md
    - model_selection:
      - api/model-selection/BanditClassifier.md
      - api/model-selection/BanditRegressor.md
      - api/model-selection/GreedyRegressor.md
      - api/model-selection/SuccessiveHalvingClassifier.md
      - api/model-selection/SuccessiveHalvingRegressor.md
      - base:
        - api/model-selection/base/ModelSelectionClassifier.md
        - api/model-selection/base/ModelSelectionRegressor.md
    - multiclass:
      - api/multiclass/OneVsOneClassifier.md
      - api/multiclass/OneVsRestClassifier.md
      - api/multiclass/OutputCodeClassifier.md
    - multioutput:
      - api/multioutput/ClassifierChain.md
      - api/multioutput/MonteCarloClassifierChain.md
      - api/multioutput/MultiClassEncoder.md
      - api/multioutput/PerOutputClassifier.md
      - api/multioutput/PerOutputRegressor.md
      - api/multioutput/ProbabilisticClassifierChain.md
      - api/multioutput/RegressorChain.md
    - naive_bayes:
      - api/naive-bayes/BernoulliNB.md
      - api/naive-bayes/ComplementNB.md
      - api/naive-bayes/GaussianNB.md
      - api/naive-bayes/MultinomialNB.md
    - neighbors:
      - api/neighbors/KNNClassifier.md
      - api/neighbors/KNNRegressor.md
      - api/neighbors/LazySearch.md
      - api/neighbors/SWINN.md
    - optim:
      - api/optim/AMSGrad.md
      - api/optim/AdaBound.md
      - api/optim/AdaDelta.md
      - api/optim/AdaGrad.md
      - api/optim/AdaMax.md
      - api/optim/Adam.md
      - api/optim/Averager.md
      - api/optim/FTRLProximal.md
      - api/optim/Momentum.md
      - api/optim/Nadam.md
      - api/optim/NesterovMomentum.md
      - api/optim/Newton.md
      - api/optim/Optimizer.md
      - api/optim/RMSProp.md
      - api/optim/SGD.md
      - base:
        - api/optim/base/Initializer.md
        - api/optim/base/Loss.md
        - api/optim/base/Optimizer.md
        - api/optim/base/Scheduler.md
      - initializers:
        - api/optim/initializers/Constant.md
        - api/optim/initializers/Normal.md
        - api/optim/initializers/Zeros.md
      - losses:
        - api/optim/losses/Absolute.md
        - api/optim/losses/BinaryFocalLoss.md
        - api/optim/losses/BinaryLoss.md
        - api/optim/losses/Cauchy.md
        - api/optim/losses/CrossEntropy.md
        - api/optim/losses/EpsilonInsensitiveHinge.md
        - api/optim/losses/Hinge.md
        - api/optim/losses/Huber.md
        - api/optim/losses/Log.md
        - api/optim/losses/MultiClassLoss.md
        - api/optim/losses/Poisson.md
        - api/optim/losses/Quantile.md
        - api/optim/losses/RegressionLoss.md
        - api/optim/losses/Squared.md
      - schedulers:
        - api/optim/schedulers/Constant.md
        - api/optim/schedulers/InverseScaling.md
        - api/optim/schedulers/Optimal.md
    - preprocessing:
      - api/preprocessing/AdaptiveStandardScaler.md
      - api/preprocessing/Binarizer.md
      - api/preprocessing/FeatureHasher.md
      - api/preprocessing/GaussianRandomProjector.md
      - api/preprocessing/LDA.md
      - api/preprocessing/MaxAbsScaler.md
      - api/preprocessing/MinMaxScaler.md
      - api/preprocessing/Normalizer.md
      - api/preprocessing/OneHotEncoder.md
      - api/preprocessing/OrdinalEncoder.md
      - api/preprocessing/PredClipper.md
      - api/preprocessing/PreviousImputer.md
      - api/preprocessing/RobustScaler.md
      - api/preprocessing/SparseRandomProjector.md
      - api/preprocessing/StandardScaler.md
      - api/preprocessing/StatImputer.md
      - api/preprocessing/TargetMinMaxScaler.md
      - api/preprocessing/TargetStandardScaler.md
    - proba:
      - api/proba/Beta.md
      - api/proba/Gaussian.md
      - api/proba/Multinomial.md
      - api/proba/MultivariateGaussian.md
      - base:
        - api/proba/base/BinaryDistribution.md
        - api/proba/base/ContinuousDistribution.md
        - api/proba/base/DiscreteDistribution.md
        - api/proba/base/Distribution.md
    - reco:
      - api/reco/Baseline.md
      - api/reco/BiasedMF.md
      - api/reco/FunkMF.md
      - api/reco/RandomNormal.md
      - base:
        - api/reco/base/Ranker.md
    - rules:
      - api/rules/AMRules.md
    - sketch:
      - api/sketch/Counter.md
      - api/sketch/HeavyHitters.md
      - api/sketch/Histogram.md
      - api/sketch/NUnique.md
      - api/sketch/Set.md
    - stats:
      - api/stats/AbsMax.md
      - api/stats/AutoCorr.md
      - api/stats/BayesianMean.md
      - api/stats/ChiSquared.md
      - api/stats/Count.md
      - api/stats/Cov.md
      - api/stats/EWCov.md
      - api/stats/EWMean.md
      - api/stats/EWVar.md
      - api/stats/Entropy.md
      - api/stats/IQR.md
      - api/stats/KolmogorovSmirnov.md
      - api/stats/Kurtosis.md
      - api/stats/Link.md
      - api/stats/MAD.md
      - api/stats/Max.md
      - api/stats/Mean.md
      - api/stats/Min.md
      - api/stats/Mode.md
      - api/stats/PeakToPeak.md
      - api/stats/PearsonCorr.md
      - api/stats/Quantile.md
      - api/stats/RollingAbsMax.md
      - api/stats/RollingIQR.md
      - api/stats/RollingMax.md
      - api/stats/RollingMin.md
      - api/stats/RollingMode.md
      - api/stats/RollingPeakToPeak.md
      - api/stats/RollingQuantile.md
      - api/stats/SEM.md
      - api/stats/Shift.md
      - api/stats/Skew.md
      - api/stats/Sum.md
      - api/stats/Var.md
      - base:
        - api/stats/base/Bivariate.md
        - api/stats/base/Univariate.md
    - stream:
      - api/stream/Cache.md
      - api/stream/TwitchChatStream.md
      - api/stream/TwitterLiveStream.md
      - api/stream/iter-arff.md
      - api/stream/iter-array.md
      - api/stream/iter-csv.md
      - api/stream/iter-frame.md
      - api/stream/iter-libsvm.md
      - api/stream/iter-pandas.md
      - api/stream/iter-polars.md
      - api/stream/iter-sklearn-dataset.md
      - api/stream/iter-sql.md
      - api/stream/shuffle.md
      - api/stream/simulate-qa.md
    - time_series:
      - api/time-series/ForecastingMetric.md
      - api/time-series/HoltWinters.md
      - api/time-series/HorizonAggMetric.md
      - api/time-series/HorizonMetric.md
      - api/time-series/SNARIMAX.md
      - api/time-series/evaluate.md
      - api/time-series/iter-evaluate.md
      - base:
        - api/time-series/base/Forecaster.md
    - tree:
      - api/tree/ExtremelyFastDecisionTreeClassifier.md
      - api/tree/HoeffdingAdaptiveTreeClassifier.md
      - api/tree/HoeffdingAdaptiveTreeRegressor.md
      - api/tree/HoeffdingTreeClassifier.md
      - api/tree/HoeffdingTreeRegressor.md
      - api/tree/ISOUPTreeRegressor.md
      - api/tree/LASTClassifier.md
      - api/tree/SGTClassifier.md
      - api/tree/SGTRegressor.md
      - base:
        - api/tree/base/Branch.md
        - api/tree/base/Leaf.md
      - splitter:
        - api/tree/splitter/DynamicQuantizer.md
        - api/tree/splitter/EBSTSplitter.md
        - api/tree/splitter/ExhaustiveSplitter.md
        - api/tree/splitter/GaussianSplitter.md
        - api/tree/splitter/HistogramSplitter.md
        - api/tree/splitter/QOSplitter.md
        - api/tree/splitter/Quantizer.md
        - api/tree/splitter/Splitter.md
        - api/tree/splitter/StaticQuantizer.md
        - api/tree/splitter/TEBSTSplitter.md
    - utils:
      - api/utils/Rolling.md
      - api/utils/SortedWindow.md
      - api/utils/TimeRolling.md
      - api/utils/VectorDict.md
      - api/utils/expand-param-grid.md
      - api/utils/log-method-calls.md
      - math:
        - api/utils/math/argmax.md
        - api/utils/math/chain-dot.md
        - api/utils/math/clamp.md
        - api/utils/math/dot.md
        - api/utils/math/dotvecmat.md
        - api/utils/math/log-sum-2-exp.md
        - api/utils/math/matmul2d.md
        - api/utils/math/minkowski-distance.md
        - api/utils/math/norm.md
        - api/utils/math/outer.md
        - api/utils/math/prod.md
        - api/utils/math/sherman-morrison.md
        - api/utils/math/sigmoid.md
        - api/utils/math/sign.md
        - api/utils/math/softmax.md
        - api/utils/math/woodbury-matrix.md
      - norm:
        - api/utils/norm/normalize-values-in-dict.md
        - api/utils/norm/scale-values-in-dict.md
      - pretty:
        - api/utils/pretty/humanize-bytes.md
        - api/utils/pretty/print-table.md
      - random:
        - api/utils/random/exponential.md
        - api/utils/random/poisson.md
  - Examples:
    - examples/batch-to-online.md
    - examples/bike-sharing-forecasting.md
    - examples/building-a-simple-nowcasting-model.md
    - examples/content-personalization.md
    - examples/debugging-a-pipeline.md
    - examples/imbalanced-learning.md
    - Matrix factorization for recommender systems:
      - examples/matrix-factorization-for-recommender-systems/part-1.md
      - examples/matrix-factorization-for-recommender-systems/part-2.md
      - examples/matrix-factorization-for-recommender-systems/part-3.md
    - examples/quantile-regression-uncertainty.md
    - examples/sentence-classification.md
    - examples/the-art-of-using-pipelines.md
    - examples/on-hoeffding-trees.md
  - FAQ: faq
  - Releases:
    - "0.26.1": releases/0.26.1.md
    - "0.26.0": releases/0.26.0.md
    - "0.25.0": releases/0.25.0.md
    - "0.24.2": releases/0.24.2.md
    - "0.24.1": releases/0.24.1.md
    - "0.24.0": releases/0.24.0.md
    - "0.23.0": releases/0.23.0.md
    - "0.22.0": releases/0.22.0.md
    - "0.21.2": releases/0.21.2.md
    - "0.21.1": releases/0.21.1.md
    - "0.21.0": releases/0.21.0.md
    - "0.20.1": releases/0.20.1.md
    - "0.20.0": releases/0.20.0.md
    - "0.19.0": releases/0.19.0.md
    - "0.18.0": releases/0.18.0.md
    - "0.17.0": releases/0.17.0.md
    - "0.16.0": releases/0.16.0.md
    - "0.15.0": releases/0.15.0.md
    - "0.14.0": releases/0.14.0.md
    - "0.13.0": releases/0.13.0.md
    - "0.12.1": releases/0.12.1.md
    - "0.12.0": releases/0.12.0.md
    - "0.11.1": releases/0.11.1.md
    - "0.11.0": releases/0.11.0.md
    - "0.10.1": releases/0.10.1.md
    - "0.10.0": releases/0.10.0.md
    - "0.9.0": releases/0.9.0.md
    - "0.8.0": releases/0.8.0.md
    - "0.7.1": releases/0.7.1.md
    - "0.7.0": releases/0.7.0.md
    - "0.6.1": releases/0.6.1.md
    - "0.6.0": releases/0.6.0.md
    - "0.5.1": releases/0.5.1.md
    - "0.5.0": releases/0.5.0.md
    - "0.4.4": releases/0.4.4.md
    - "0.4.3": releases/0.4.3.md
    - "0.4.1": releases/0.4.1.md
    - "0.3.0": releases/0.3.0.md
    - "0.2.0": releases/0.2.0.md
    - "0.1.0": releases/0.1.0.md
    - "0.0.3": releases/0.0.3.md
    - "0.0.2": releases/0.0.2.md
  - Benchmarks: benchmarks
  - License: license

# Configuration
theme:
  name: material
  variant: classic
  custom_dir: docs/overrides
  language: en

  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  font:
    text: Fira Sans
    code: Fira Code
  logo: img/icon.png
  favicon: img/favicon.ico
  features:
    - content.action.copy
    - content.code.copy
    - navigation.tabs
    - navigation.instant
    - navigation.indexes
    - navigation.prune

# Extras
extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/online-ml/river
  version:
    provider: mike

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - tables
  - toc:
      permalink: true
      toc_depth: "1-3"
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences

plugins:
  - search
  - llmstxt:
      sections:
        Documentation:
          - introduction/*.md
          - recipes/*.md
          - examples/*.md
          - faq/index.md
        API reference:
          - api/*.md
        Optional:
          - benchmarks/index.md
          - license/index.md

strict: true

validation:
  unresolved_references: true
  unresolved_footnotes: true
  unused_definitions: true
  unused_footnotes: true
  shadowed_definitions: true
  shadowed_footnotes: true
  invalid_links: true
  invalid_link_anchors: true

extra_javascript:
  - javascripts/config.js
  - https://cdn.jsdelivr.net/npm/mathjax@3.2/es5/tex-mml-chtml.js
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js

extra_css:
  - stylesheets/extra.css