blob: 9198cea63e19416bed36acdca46d85a6161f294c [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="This module implements the data loader."><meta name="keywords" content="rust, rustlang, rust-lang, input"><title>gbdt::input - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../gbdt/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../gbdt/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module input</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">gbdt</a>::<wbr><a class="mod" href="#">input</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/gbdt/input.rs.html#1-579">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This module implements the data loader.</p>
<p>Currently we support to kind of input format: csv format and libsvm data format.</p>
<h2 id="example"><a href="#example">Example</a></h2><h3 id="libsvm-format"><a href="#libsvm-format">LibSVM format</a></h3>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::input::InputFormat;
<span class="kw">use </span>gbdt::input;
<span class="kw">let </span>test_file = <span class="string">&quot;data/xgb_binary_logistic/agaricus.txt.test&quot;</span>;
<span class="kw">let </span><span class="kw-2">mut </span>fmt = input::InputFormat::txt_format();
fmt.set_feature_size(<span class="number">126</span>);
fmt.set_delimeter(<span class="string">&#39; &#39;</span>);
<span class="kw">let </span>test_data = input::load(test_file, fmt);</code></pre></div>
<h3 id="csv-format"><a href="#csv-format">CSV format</a></h3>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gbdt::input::InputFormat;
<span class="kw">use </span>gbdt::input;
<span class="kw">let </span>test_file = <span class="string">&quot;data/xgb_multi_softmax/dermatology.data.test&quot;</span>;
<span class="kw">let </span><span class="kw-2">mut </span>fmt = InputFormat::csv_format();
fmt.set_feature_size(<span class="number">34</span>);
<span class="kw">let </span>test_data = input::load(test_file, fmt);</code></pre></div>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InputFormat.html" title="gbdt::input::InputFormat struct">InputFormat</a></div><div class="item-right docblock-short">The input file format struct.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.FileFormat.html" title="gbdt::input::FileFormat enum">FileFormat</a></div><div class="item-right docblock-short">This enum type defines the data file format.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.infer.html" title="gbdt::input::infer fn">infer</a></div><div class="item-right docblock-short">Function used for input file type inference. This can help recognize the file format.
If the file is in csv type, this function also helps to check whether the csv file has
header.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.load.html" title="gbdt::input::load fn">load</a></div><div class="item-right docblock-short">Load file with certain input format.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.load_csv.html" title="gbdt::input::load_csv fn">load_csv</a></div><div class="item-right docblock-short">Load csv file.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.load_txt.html" title="gbdt::input::load_txt fn">load_txt</a></div><div class="item-right docblock-short">Load txt file.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="gbdt" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>