logo

v5.7.0

Users Guide

  • Installing Larch
  • Choice Models
    • Data Fundamentals
    • Linear Functions
    • Machine Learning
  • References

API Reference

  • Data
    • Dataset
      • larch.Dataset
      • larch.Dataset.construct
      • larch.Dataset.dims
      • larch.Dataset.sizes
      • larch.Dataset.data_vars
      • larch.Dataset.coords
      • larch.Dataset.attrs
      • larch.Dataset.encoding
      • larch.Dataset.indexes
      • larch.Dataset.chunks
      • larch.Dataset.chunksizes
      • larch.Dataset.nbytes
      • larch.Dataset.set_dtypes
    • DataTree
      • larch.DataTree
      • larch.DataTree.root_node_name
      • larch.DataTree.subspaces
      • larch.DataTree.relationships_are_digitized
      • larch.DataTree.n_cases
      • larch.DataTree.n_alts
      • larch.DataTree.CASEID
      • larch.DataTree.ALTID
      • larch.DataTree.add_dataset
      • larch.DataTree.add_relationship
      • larch.DataTree.digitize_relationships
      • larch.DataTree.query_cases
      • larch.DataTree.replace_datasets
      • larch.DataTree.setup_flow
    • DataFrames
      • larch.DataFrames
  • Models
    • Model
      • larch.numba.Model
      • larch.numba.Model.datatree
      • larch.numba.Model.dataset
      • larch.numba.Model.n_cases
      • larch.numba.Model.choice_ca_var
      • larch.numba.Model.choice_co_vars
      • larch.numba.Model.choice_co_code
      • larch.numba.Model.availability_ca_var
      • larch.numba.Model.availability_co_vars
      • larch.numba.Model.utility_ca
      • larch.numba.Model.utility_co
      • larch.numba.Model.quantity_ca
      • larch.numba.Model.pf
      • larch.numba.Model.most_recent_estimation_result
      • larch.numba.Model.possible_overspecification
      • larch.numba.Model.set_values
      • larch.numba.Model.lock_value
      • larch.numba.Model.set_cap
      • larch.numba.Model.remove_unused_parameters
      • larch.numba.Model.maximize_loglike
      • larch.numba.Model.calculate_parameter_covariance
      • larch.numba.Model.loglike_nil
      • larch.numba.Model.loglike_null
      • larch.numba.Model.rho_sq_nil
      • larch.numba.Model.rho_sq_null
      • larch.numba.Model.parameter_summary
      • larch.numba.Model.estimation_statistics
      • larch.numba.Model.to_xlsx
      • larch.numba.Model.bhhh
      • larch.numba.Model.check_d_loglike
      • larch.numba.Model.d_loglike
      • larch.numba.Model.d_loglike_casewise
      • larch.numba.Model.loglike
      • larch.numba.Model.loglike_casewise
      • larch.numba.Model.logsums
      • larch.numba.Model.probability
      • larch.numba.Model.quantity
      • larch.numba.Model.total_weight
      • larch.numba.Model.utility
    • Linear Functions
    • NestingTree
      • larch.model.tree.NestingTree
      • larch.model.tree.NestingTree.new_node
      • larch.model.tree.NestingTree.add_node
      • larch.model.tree.NestingTree.remove_node
      • larch.model.tree.NestingTree.add_edge
      • larch.model.tree.NestingTree.remove_edge
    • ModelGroup
      • larch.model.model_group.ModelGroup
      • larch.model.model_group.ModelGroup.n_cases
      • larch.model.model_group.ModelGroup.set_values
      • larch.model.model_group.ModelGroup.total_weight
      • larch.model.model_group.ModelGroup.loglike
      • larch.model.model_group.ModelGroup.loglike2
      • larch.model.model_group.ModelGroup.to_xlsx

Examples

  • MTC Mode Choice
    • MTC Work Mode Choice Data
    • 1: MTC MNL Mode Choice
    • 2: MTC MNL Mode Choice, Motorized
    • 17a: Market Segmentatation
    • 17: MTC Expanded MNL Mode Choice
    • 22: MTC Motorized and Non-Motorized Nested Mode Choice
    • 28: MTC Motorized - Shared Ride - Non-Motorized Nested Mode Choice
  • Swissmetro
    • 101: Swissmetro MNL Mode Choice
    • 102: Swissmetro Weighted MNL Mode Choice
    • 109: Swissmetro Nested Logit Mode Choice
  • Exampville
    • 200: Exampville Simulated Data
    • 201: Exampville Mode Choice
    • 202: Exampville Mode Choice Logsums
    • 203: Exampville Destination Choice
  • Itinerary Choice
    • 300: Itinerary Choice Data
    • 301: Itinerary Choice using MNL
  • Legacy Examples
    • MTC Mode Choice Examples
      • MTC Work Mode Choice Data
      • 1: MTC MNL Mode Choice
      • 2: MTC MNL Mode Choice, Motorized
      • 3: MTC MNL Mode Choice, Zeroed Shared
      • 5: MTC MNL Mode Choice, Motorized Travel Time
      • 6: MTC MNL Mode Choice, Motorized Times
      • 7: MTC MNL Mode Choice, Diminishing OVTT by Distance
      • 8: MTC MNL Mode Choice, TTR = 2.5
      • 9: MTC MNL Mode Choice, TTR = 4.0
      • 10: MTC MNL Mode Choice, Autos per Household
      • 11: MTC MNL Mode Choice, Vehicle by Worker
      • 12: MTC MNL Mode Choice, Autos per Adult
      • 13: MTC MNL Mode Choice, CBD
      • 14: MTC MNL Mode Choice, Work Zone Density
      • 15: MTC MNL Mode Choice, CBD and Work Zone Density
      • 16: MTC MNL Mode Choice, Cost by Income
      • 17A: MTC MNL Mode Choice, Segmented for 1 or fewer cars
      • 17B: MTC MNL Mode Choice, Segmented for 2 or more cars
      • 17C: MTC MNL Mode Choice, Segmented for Males
      • 17D: MTC MNL Mode Choice, Segmented for Females
      • 17: MTC Expanded MNL Mode Choice
      • 18: MTC Motorized Nested Mode Choice
      • 19: MTC Private Auto Nested Mode Choice
      • 20: MTC Shared Ride Nested Mode Choice
      • 21: MTC Non-Motorized Nested Mode Choice
      • 22: MTC Motorized and Non-Motorized Nested Mode Choice
      • 23W: MTC Private Auto - Non-Motorized Nested Mode Choice
      • 23W: MTC Shared Ride - Non-Motorized Nested Mode Choice
      • 25: MTC Private Auto - Motorized Nested Mode Choice
      • 26: MTC Shared Ride - Motorized Nested Mode Choice
      • 27: MTC Shared Ride - Private Auto Nested Mode Choice
      • 28: MTC Motorized - Shared Ride - Non-Motorized Nested Mode Choice
      • 29: MTC Motorized - Shared Ride - Private Auto Nested Mode Choice
    • Swissmetro Examples
      • 101: Swissmetro MNL Mode Choice
      • 102: Swissmetro Weighted MNL Mode Choice
      • 107: Latent Class Models
      • 109: Swissmetro Nested Logit Mode Choice
      • 111: Swissmetro Cross-Nested Logit Mode Choice
    • Itinerary Choice Examples
      • 300L: Itinerary Choice Data
      • 301: Itinerary Choice using MNL
      • 302: Itinerary Choice using Simple Nested Logit

Data

DataΒΆ

  • Dataset
    • larch.Dataset
    • larch.Dataset.construct
    • larch.Dataset.dims
    • larch.Dataset.sizes
    • larch.Dataset.data_vars
    • larch.Dataset.coords
    • larch.Dataset.attrs
    • larch.Dataset.encoding
    • larch.Dataset.indexes
    • larch.Dataset.chunks
    • larch.Dataset.chunksizes
    • larch.Dataset.nbytes
    • larch.Dataset.set_dtypes
  • DataTree
    • larch.DataTree
    • larch.DataTree.root_node_name
    • larch.DataTree.subspaces
    • larch.DataTree.relationships_are_digitized
    • larch.DataTree.n_cases
    • larch.DataTree.n_alts
    • larch.DataTree.CASEID
    • larch.DataTree.ALTID
    • larch.DataTree.add_dataset
    • larch.DataTree.add_relationship
    • larch.DataTree.digitize_relationships
    • larch.DataTree.query_cases
    • larch.DataTree.replace_datasets
    • larch.DataTree.setup_flow
  • DataFrames
    • larch.DataFrames

previous

References

next

Dataset

By Jeffrey Newman
© Copyright 2021.