Package: cito 1.1

Maximilian Pichler

cito: Building and Training Neural Networks

The 'cito' package provides a user-friendly interface for training and interpreting deep neural networks (DNN). 'cito' simplifies the fitting of DNNs by supporting the familiar formula syntax, hyperparameter tuning under cross-validation, and helps to detect and handle convergence problems. DNNs can be trained on CPU, GPU and MacOS GPUs. In addition, 'cito' has many downstream functionalities such as various explainable AI (xAI) metrics (e.g. variable importance, partial dependence plots, accumulated local effect plots, and effect estimates) to interpret trained DNNs. 'cito' optionally provides confidence intervals (and p-values) for all xAI metrics and predictions. At the same time, 'cito' is computationally efficient because it is based on the deep learning framework 'torch'. The 'torch' package is native to R, so no Python installation or other API is required for this package.

Authors:Christian Amesöder [aut], Maximilian Pichler [aut, cre], Florian Hartig [ctb], Armin Schenk [ctb]

cito_1.1.tar.gz
cito_1.1.zip(r-4.5)cito_1.1.zip(r-4.4)cito_1.1.zip(r-4.3)
cito_1.1.tgz(r-4.4-any)cito_1.1.tgz(r-4.3-any)
cito_1.1.tar.gz(r-4.5-noble)cito_1.1.tar.gz(r-4.4-noble)
cito_1.1.tgz(r-4.4-emscripten)cito_1.1.tgz(r-4.3-emscripten)
cito.pdf |cito.html
cito/json (API)
NEWS

# Install 'cito' in R:
install.packages('cito', repos = c('https://citoverse.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/citoverse/cito/issues

On CRAN:

machine-learningneural-network

12 exports 37 stars 3.20 score 50 dependencies 94 scripts 340 downloads

Last updated 2 months agofrom:49e596f777. Checks:OK: 1 WARNING: 6. Indexed: yes.

TargetResultDate
Doc / VignettesOKSep 13 2024
R-4.5-winWARNINGSep 13 2024
R-4.5-linuxWARNINGSep 13 2024
R-4.4-winWARNINGSep 13 2024
R-4.4-macWARNINGSep 13 2024
R-4.3-winWARNINGSep 13 2024
R-4.3-macWARNINGSep 13 2024

Exports:ALEanalyze_trainingconditionalEffectsconfig_lr_schedulerconfig_optimizerconfig_tuningcontinue_trainingdnnemultinomial_log_probPDPtune

Dependencies:abindbackportsbitbit64bootcallrcheckmateclicorocrayondescellipsisfansifilelockfsgluegridExtragtablehmsjpegjsonlitelatticelifecyclelme4magrittrMASSMatrixminqanlmenloptrparabarpillarpkgconfigpngprettyunitsprocessxprogresspsR6rappdirsRcppRcppEigenrlangsafetensorstibbletorchtorchvisionutf8vctrswithr

Advanced: Custom loss functions and prediction intervals

Rendered fromD-Advanced_custom_loss_functions.Rmdusingknitr::rmarkdownon Sep 13 2024.

Last update: 2024-03-05
Started: 2023-09-29

Example: (Multi-) Species distribution models with cito

Rendered fromC-Example_Species_distribution_modeling.Rmdusingknitr::rmarkdownon Sep 13 2024.

Last update: 2024-03-18
Started: 2023-09-29

Introduction to cito

Rendered fromA-Introduction_to_cito.Rmdusingknitr::rmarkdownon Sep 13 2024.

Last update: 2024-03-16
Started: 2023-09-29

Training neural networks

Rendered fromB-Training_neural_networks.Rmdusingknitr::rmarkdownon Sep 13 2024.

Last update: 2024-03-06
Started: 2023-09-29

Readme and manuals

Help Manual

Help pageTopics
Accumulated Local Effect Plot (ALE)ALE ALE.citodnn ALE.citodnnBootstrap
Visualize training of Neural Networkanalyze_training
Average pooling layeravgPool
'cito': Building and training neural networkscito-package cito
CNNcnn
Returns list of parameters the neural network model currently has in usecoef.citocnn
Returns list of parameters the neural network model currently has in usecoef.citodnn coef.citodnnBootstrap
Calculate average conditional effectsconditionalEffects conditionalEffects.citodnn conditionalEffects.citodnnBootstrap
Creation of customized learning rate scheduler objectsconfig_lr_scheduler
Creation of customized optimizer objectsconfig_optimizer
Config hyperparameter tuningconfig_tuning
Continues training of a model generated with 'dnn' or 'cnn' for additional epochs.continue_training continue_training.citocnn continue_training.citodnn continue_training.citodnnBootstrap
Convolutional layerconv
CNN architecturecreate_architecture
DNNdnn
Embeddingse
list of specials - taken from enum.RfindReTrmClasses
Linear layerlinear
Maximum pooling layermaxPool
Multinomial log likelihoodmultinomial_log_prob
Partial Dependence Plot (PDP)PDP PDP.citodnn PDP.citodnnBootstrap
Plot the CNN architectureplot.citoarchitecture
Plot the CNN architectureplot.citocnn
Creates graph plot which gives an overview of the network architecture.plot.citodnn plot.citodnnBootstrap
Predict from a fitted cnn modelpredict.citocnn
Predict from a fitted dnn modelpredict.citodnn predict.citodnnBootstrap
Print pooling layerprint.avgPool
Print class citoarchitectureprint.citoarchitecture
Print class citocnnprint.citocnn
Print class citodnnprint.citodnn print.citodnnBootstrap
Print average conditional effectsprint.conditionalEffects print.conditionalEffectsBootstrap
Print conv layerprint.conv
Print linear layerprint.linear
Print pooling layerprint.maxPool
Print method for class summary.citodnnprint.summary.citodnn print.summary.citodnnBootstrap
Print transfer modelprint.transfer
Extract Model Residualsresiduals.citodnn
Data Simulation for CNNsimulate_shapes
Summary citocnnsummary.citocnn
Summarize Neural Network of class citodnnsummary.citodnn summary.citodnnBootstrap
combine a list of formula terms as a sumsumTerms
Transfer learningtransfer
Tune hyperparametertune