Medial Code Documentation
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
xgboost.data.SingleBatchInternalIter Class Reference
Inheritance diagram for xgboost.data.SingleBatchInternalIter:
xgboost.core.DataIter

Public Member Functions

None __init__ (self, **Any kwargs)
 
int next (self, Callable input_data)
 
None reset (self)
 
- Public Member Functions inherited from xgboost.core.DataIter
Tuple[Callable, Callable] get_callbacks (self, bool allow_host, bool enable_categorical)
 
"_ProxyDMatrix" proxy (self)
 
None reraise (self)
 
None __del__ (self)
 

Data Fields

 kwargs
 
 it
 
- Data Fields inherited from xgboost.core.DataIter
 cache_prefix
 
 proxy
 

Additional Inherited Members

- Protected Member Functions inherited from xgboost.core.DataIter
_T _handle_exception (self, Callable fn, _T dft_ret)
 
None _reset_wrapper (self, None this)
 
int _next_wrapper (self, None this)
 
- Protected Attributes inherited from xgboost.core.DataIter
 _handle
 
 _enable_categorical
 
 _allow_host
 
 _release
 
 _reset_callback
 
 _next_callback
 
 _next_wrapper
 
 _exception
 
 _temporary_data
 
 _data_ref
 

Detailed Description

An iterator for single batch data to help creating device DMatrix.
Transforming input directly to histogram with normal single batch data API
can not access weight for sketching.  So this iterator acts as a staging
area for meta info.

Constructor & Destructor Documentation

◆ __init__()

None xgboost.data.SingleBatchInternalIter.__init__ (   self,
**Any  kwargs 
)

Reimplemented from xgboost.core.DataIter.

Member Function Documentation

◆ next()

int xgboost.data.SingleBatchInternalIter.next (   self,
Callable  input_data 
)
Set the next batch of data.

Parameters
----------

input_data:
    A function with same data fields like `data`, `label` with
    `xgboost.DMatrix`.

Returns
-------
0 if there's no more batch, otherwise 1.

Reimplemented from xgboost.core.DataIter.

◆ reset()

None xgboost.data.SingleBatchInternalIter.reset (   self)

Reimplemented from xgboost.core.DataIter.


The documentation for this class was generated from the following file: