Skip to main content
Back to top
Ctrl
+
K
caf.toolkit 0.12.0+84.g3c1226e
Quick Start
User Guide
API Reference
Changelog
More
Issues
CAF Handbook
Search
Ctrl
+
K
GitHub
Search
Ctrl
+
K
Quick Start
User Guide
API Reference
Changelog
Issues
CAF Handbook
GitHub
Section Navigation
caf.toolkit
write_metadata
BaseConfig
BaseConfig.__init__
BaseConfig.construct
BaseConfig.copy
BaseConfig.dict
BaseConfig.from_orm
BaseConfig.from_yaml
BaseConfig.json
BaseConfig.load_yaml
BaseConfig.model_construct
BaseConfig.model_copy
BaseConfig.model_dump
BaseConfig.model_dump_json
BaseConfig.model_json_schema
BaseConfig.model_parametrized_name
BaseConfig.model_post_init
BaseConfig.model_rebuild
BaseConfig.model_validate
BaseConfig.model_validate_json
BaseConfig.model_validate_strings
BaseConfig.parse_file
BaseConfig.parse_obj
BaseConfig.parse_raw
BaseConfig.save_yaml
BaseConfig.schema
BaseConfig.schema_json
BaseConfig.to_yaml
BaseConfig.update_forward_refs
BaseConfig.validate
BaseConfig.write_example
LogHelper
LogHelper.__init__
LogHelper.add_console_handler
LogHelper.add_file_handler
LogHelper.add_handler
LogHelper.capture_warnings
LogHelper.cleanup_handlers
LogHelper.write_instantiate_message
SystemInformation
SystemInformation.__init__
SystemInformation.load
TemporaryLogFile
TemporaryLogFile.__init__
ToolDetails
ToolDetails.__init__
caf.toolkit.arguments
getenv_bool
parse_arg_details
ModelArguments
ModelArguments.__init__
ModelArguments.add_arguments
ModelArguments.add_config_arguments
ModelArguments.add_subcommands
TidyUsageArgumentDefaultsHelpFormatter
TidyUsageArgumentDefaultsHelpFormatter.__init__
TidyUsageArgumentDefaultsHelpFormatter.add_argument
TidyUsageArgumentDefaultsHelpFormatter.add_arguments
TidyUsageArgumentDefaultsHelpFormatter.add_text
TidyUsageArgumentDefaultsHelpFormatter.add_usage
TidyUsageArgumentDefaultsHelpFormatter.end_section
TidyUsageArgumentDefaultsHelpFormatter.format_help
TidyUsageArgumentDefaultsHelpFormatter.start_section
TypeAnnotationWarning
caf.toolkit.concurrency
multiprocess
caf.toolkit.concurrency.multiprocessing_wrapper
create_kill_pool_fn
multiprocess
wait_for_pool_results
Any
TypeVar
caf.toolkit.config_base
asdict
is_dataclass
overload
write_config
BaseConfig
BaseConfig.__init__
BaseConfig.construct
BaseConfig.copy
BaseConfig.dict
BaseConfig.from_orm
BaseConfig.from_yaml
BaseConfig.json
BaseConfig.load_yaml
BaseConfig.model_construct
BaseConfig.model_copy
BaseConfig.model_dump
BaseConfig.model_dump_json
BaseConfig.model_json_schema
BaseConfig.model_parametrized_name
BaseConfig.model_post_init
BaseConfig.model_rebuild
BaseConfig.model_validate
BaseConfig.model_validate_json
BaseConfig.model_validate_strings
BaseConfig.parse_file
BaseConfig.parse_obj
BaseConfig.parse_raw
BaseConfig.save_yaml
BaseConfig.schema
BaseConfig.schema_json
BaseConfig.to_yaml
BaseConfig.update_forward_refs
BaseConfig.validate
BaseConfig.write_example
Path
Path.__init__
Path.absolute
Path.as_posix
Path.as_uri
Path.chmod
Path.cwd
Path.exists
Path.expanduser
Path.glob
Path.group
Path.hardlink_to
Path.home
Path.is_absolute
Path.is_block_device
Path.is_char_device
Path.is_dir
Path.is_fifo
Path.is_file
Path.is_mount
Path.is_relative_to
Path.is_reserved
Path.is_socket
Path.is_symlink
Path.iterdir
Path.joinpath
Path.lchmod
Path.link_to
Path.lstat
Path.match
Path.mkdir
Path.open
Path.owner
Path.read_bytes
Path.read_text
Path.readlink
Path.relative_to
Path.rename
Path.replace
Path.resolve
Path.rglob
Path.rmdir
Path.samefile
Path.stat
Path.symlink_to
Path.touch
Path.unlink
Path.with_name
Path.with_stem
Path.with_suffix
Path.write_bytes
Path.write_text
caf.toolkit.core
caf.toolkit.core.types
caf.toolkit.cost_utils
cost_distribution
create_log_bins
dynamic_cost_distribution
intrazonal_cost_infill
normalised_cost_distribution
CostDistribution
CostDistribution.__init__
CostDistribution.band_share_convergence
CostDistribution.band_share_residuals
CostDistribution.calculate_weighted_averages
CostDistribution.copy
CostDistribution.create_similar
CostDistribution.from_data
CostDistribution.from_data_no_bins
CostDistribution.from_file
CostDistribution.trip_residuals
caf.toolkit.io
find_file_with_name
read_csv
read_csv_matrix
safe_dataframe_to_csv
Any
Any.__init__
Callable
Callable.__init__
Hashable
Hashable.__init__
Iterable
Iterable.__init__
Sequence
Sequence.__init__
Sequence.count
Sequence.index
TypeVar
TypeVar.__init__
MissingColumnsError
caf.toolkit.log_helpers
capture_warnings
get_console_handler
get_custom_logger
get_file_handler
get_logger
git_describe
write_information
write_instantiate_message
write_metadata
Annotated
Annotated.__init__
Collection
Collection.__init__
Hashable
Hashable.__init__
LogHelper
LogHelper.__init__
LogHelper.add_console_handler
LogHelper.add_file_handler
LogHelper.add_handler
LogHelper.capture_warnings
LogHelper.cleanup_handlers
LogHelper.write_instantiate_message
Mapping
Mapping.__init__
Mapping.get
Mapping.items
Mapping.keys
Mapping.values
PackageFilter
PackageFilter.__init__
PackageFilter.filter
Protocol
Protocol.__init__
SystemInformation
SystemInformation.__init__
SystemInformation.load
TemporaryLogFile
TemporaryLogFile.__init__
ToolDetails
ToolDetails.__init__
LoggingWarning
caf.toolkit.math_utils
check_numeric
clip_small_non_zero
curve_convergence
is_almost_equal
list_is_almost_equal
nan_report_with_input
root_mean_squared_error
Any
Any.__init__
caf.toolkit.pandas_utils
add_matrix_sums
cast_to_common_type
chunk_df
compare_matrices
compare_matrices_and_output
dataframe_to_n_dimensional_array
dataframe_to_n_dimensional_sparse_array
filter_df
filter_df_mask
get_full_index
get_wide_all_external_mask
get_wide_internal_only_mask
get_wide_mask
is_sparse_feasible
long_df_to_wide_ndarray
long_product_infill
long_to_wide_infill
matrix_describe
n_dimensional_array_to_dataframe
reindex_and_groupby_sum
reindex_cols
reindex_rows_and_cols
str_join_cols
wide_matrix_internal_external_report
wide_to_long_infill
ChunkDf
ChunkDf.__init__
MatrixReport
MatrixReport.__init__
MatrixReport.abs_difference
MatrixReport.calc_vehicle_kms
MatrixReport.from_file
MatrixReport.trip_length_distribution
MatrixReport.write_to_excel
caf.toolkit.pandas_utils.df_handling
chunk_df
filter_df
filter_df_mask
get_full_index
long_df_to_wide_ndarray
long_product_infill
long_to_wide_infill
overload
reindex_and_groupby_sum
reindex_cols
reindex_rows_and_cols
str_join_cols
wide_to_long_infill
ChunkDf
caf.toolkit.pandas_utils.matrices
add_matrix_sums
compare_matrices
compare_matrices_and_output
matrix_describe
MatrixReport
caf.toolkit.pandas_utils.numpy_conversions
dataframe_to_n_dimensional_array
dataframe_to_n_dimensional_sparse_array
is_sparse_feasible
n_dimensional_array_to_dataframe
overload
Any
caf.toolkit.pandas_utils.random
ChoiceGenerator
DataGenerator
FloatGenerator
IntGenerator
UniqueIdGenerator
caf.toolkit.pandas_utils.utility
cast_to_common_type
overload
to_numeric
caf.toolkit.pandas_utils.wide_df_handling
get_wide_all_external_mask
get_wide_internal_only_mask
get_wide_mask
wide_matrix_internal_external_report
Any
Callable
Collection
caf.toolkit.timing
current_milli_time
get_datetime
get_time
time_taken
caf.toolkit.toolbox
combine_dict_list
compare_sets
equal_ignore_order
get_missing_items
is_none_like
is_unique_list
list_safe_remove
Any
Any.__init__
Callable
Callable.__init__
Collection
Collection.__init__
Hashable
Hashable.__init__
Iterable
Iterable.__init__
TypeVar
TypeVar.__init__
caf.toolkit.tqdm_utils
std_out_err_redirect_tqdm
Generator
Generator.__init__
Generator.close
Generator.send
Generator.throw
caf.toolkit.translation
Field
TypedDict
matrix_translation_from_file
model_validator
numpy_matrix_zone_translation
numpy_vector_zone_translation
overload
pandas_long_matrix_zone_translation
pandas_matrix_zone_translation
pandas_vector_zone_translation
vector_translation_from_file
Any
Any.__init__
Collection
Collection.__init__
ConfigDict
ConfigDict.__init__
ConfigDict.clear
ConfigDict.copy
ConfigDict.fromkeys
ConfigDict.get
ConfigDict.items
ConfigDict.keys
ConfigDict.pop
ConfigDict.popitem
ConfigDict.setdefault
ConfigDict.update
ConfigDict.values
Sequence
Sequence.__init__
Sequence.count
Sequence.index
TypeVar
TypeVar.__init__
ZoneCorrespondence
ZoneCorrespondence.__init__
ZoneCorrespondence.copy
ZoneCorrespondence.get_correspondence
ZoneCorrespondencePath
ZoneCorrespondencePath.__init__
ZoneCorrespondencePath.read
caf.toolkit.validators
unique_list
Any
Any.__init__
Indices
General Index
Python Module Index
API Reference
caf.toolkit
caf.toolkit.log_helpers
Mapping
Mapping.keys
Mapping.keys
#
Mapping.
keys
(
)
→
a
set-like
object
providing
a
view
on
D's
keys
#
On this page
Mapping.keys()
Edit on GitHub