wassname/catalyst
1
0
Fork 0
mirror of https://github.com/wassname/catalyst.git synced 2026-08-12 11:50:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

DOC: Update docs on BoundColumn.

Browse Source
This commit is contained in:
Scott Sanderson
2016-03-02 12:18:36 -05:00
parent f5d6060bb4
commit ec3c370c11
1 changed files with 26 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
zipline/pipeline/data/dataset.py
+26 -2
View File
@@ -89,7 +89,23 @@ class _BoundColumnDescr(object):
class BoundColumn(Term):
"""
A Column of data that's been concretely bound to a particular dataset.
A column of data that's been concretely bound to a particular dataset.
Instances of this class are dynamically created upon access to attributes
of DataSets.
Attributes
----------
dtype : numpy.dtype
The dtype of data produced when this column is loaded.
latest : zipline.pipeline.data.Factor or zipline.pipeline.data.Filter
A Filter/Factor computing the most recently known value of this column
on each date. Produces a Filter if self.dtype == np.bool_, otherwise
produces a Factor.
dataset : zipline.pipeline.data.DataSet
The dataset to which this column is bound.
name : str
The name of this column.
"""
mask = AssetExists()
extra_input_rows = 0
@@ -120,16 +136,24 @@ class BoundColumn(Term):
@property
def dataset(self):
"""
The dataset to which this column is bound.
"""
return self._dataset
@property
def name(self):
"""
The name of this column.
"""
return self._name
@property
def qualname(self):
"""
Fully qualified of this column.
The fully-qualified of this column.
Generated by doing '.'.join([self.dataset.__name__, self.name]).
"""
return '.'.join([self.dataset.__name__, self.name])