Back to Vowpal Wabbit

VowpalWabbit Components

vowpalwabbit/readme.md

9.11.25.8 KB
Original Source

VowpalWabbit Components

Renames

Some common targets were renamed to match the new consistent style:

  • vw-bin -> vw_cli_bin
  • vw -> vw_core
  • spanning_tree -> vw_spanning_tree_bin

Component descriptions

nametargettypedescriptionpublic_depsprivate_depsexceptions
active_interactorvw_active_interactor_binEXECUTABLETool for interacting with active mode reductionsN/A
allreducevw_allreduceSTATIC_ONLYSupporting library for thread or socket based distributed learningvw_common, vw_ioYes
c_wrappervw_c_wrapperSHARED_ONLYOld C API. Cannot convey errors in current interface. Can be disabled using option VW_BUILD_VW_C_WRAPPERvw_coreYes, exceptions are thrown across boundary
clivw_cli_binEXECUTABLEPrimary VW command line interface. The vw executable.vw_coreN/A
commonvw_commonHEADER_ONLYCommon utilities that are shared by every project. The only dependencies permitted are polyfill/vocabulary typesnonstd::string-view-liteYes, also supports VW_NOEXCEPT
configvw_configSTATIC_ONLYOption parsing, and command line utilitiesvw_commonfmt::fmtYes
corevw_coreSTATIC_ONLYThis contains all remaining VW code, all reduction implementations, driver, option handlingvw_common, vw_explore, vw_allreduce, vw_config, spdlog::spdlog, fmt::fmtdl, Threads::Threads, vw_io, Boost::math, eigen, RapidJSONYes
csv_parservw_csv_parserSTATIC_ONLYParser implementation that reads csv examples. Disabled by default. Enable with VW_FEAT_CSV=ONvw_common, vw_config, vw_coreYes
explorevw_exploreHEADER_ONLYUtilities for sampling and generating exploration distributionsvw_commonNo
iovw_ioSTATIC_ONLYUtilities for input and outputvw_common, spdlog::spdlog, fmt::fmtZLIB::ZLIBYes
slimvw_slimSTATIC_ONLYMinimal inference only runtimevw_common, vw_exploreNo
spanning_treevw_spanning_tree_binEXECUTABLECommand line tool for connecting instances of vw for distributed learningvw_spanning_tree, vw_common, vw_configN/A
spanning_treevw_spanning_treeSTATIC_ONLYSupporting code for connecting instances of VW for distributed learningvw_commonThreads::ThreadsYes
fb_parservw_fb_parserSTATIC_ONLYParser implementation that reads flatbuffer examples. Disabled by default. Enable with VW_FEAT_FLATBUFFERS=On.vw_core, fb_generate_headersYes

How to generate the above table:

  1. Run CMake configure with -DVW_OUPUT_LIB_DESCRIPTIONS=On
  2. Pass the generated JSON through this website