Skip to content

Commit

Permalink
Fix up the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benkrikler committed Apr 3, 2020
1 parent 1df11c5 commit c7d9d10
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 7 additions & 1 deletion fast_carpenter/summary/binned_dataframe.py
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,11 @@ def __init__(self, name, out_dir, binning, weights=None, dataset_col=False):
excluded from the stored dataframe. Leaving this ``False`` can save
some disk-space and improve processing time, particularly if the bins are
only very sparsely filled.
observed (bool): If ``False`` bins in the dataframe will only be filled
if their are datapoints contained within them. Otherwise, depending on
the binning specification for each dimension, all bins for that
dimension will be present. Use `pad_missing: true` to force all bins
to be present.
Other Parameters:
name (str): The name of this stage (handled automatically by fast-flow)
Expand All @@ -161,7 +166,8 @@ def __init__(self, name, out_dir, binning, weights=None, dataset_col=False):
"""

def __init__(self, name, out_dir, binning, weights=None, dataset_col=True, pad_missing=False, file_format=None, observed=False):
def __init__(self, name, out_dir, binning, weights=None, dataset_col=True,
pad_missing=False, file_format=None, observed=False):
self.name = name
self.out_dir = out_dir
ins, outs, binnings = cfg.create_binning_list(self.name, binning)
Expand Down
2 changes: 1 addition & 1 deletion tests/summary/test_binned_dataframe.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def test_BinnedDataframe_run_twice(binned_df_1, tmpdir, infile):
assert totals["EventWeight:sumw"] == pytest.approx(231.91339 * 2)


@pytest.fixture #(scope="function")
@pytest.fixture
def run_twice_data_mc(config_1, infile, observed):
chunk_mc = FakeBEEvent(infile, "mc")
chunk_data = FakeBEEvent(infile, "data")
Expand Down

0 comments on commit c7d9d10

Please sign in to comment.