Skip to content

Commit 46f683f

Browse files
update docstring
1 parent 18b5716 commit 46f683f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

causal_testing/data_collection/data_collector.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,15 @@ def run_system_with_input_configuration(self, input_configuration: dict) -> pd.D
122122

123123

124124
class ObservationalDataCollector(DataCollector):
125-
"""A data collector that extracts data that is relevant to the specified scenario from a csv of execution data."""
125+
"""A data collector that extracts data that is relevant to the specified scenario from a dataframe of execution
126+
data."""
126127

127128
def __init__(self, scenario: Scenario, data: pd.DataFrame):
128129
super().__init__(scenario)
129130
self.data = data
130131

131132
def collect_data(self, **kwargs) -> pd.DataFrame:
132-
"""Read a csv containing execution data for the system-under-test into a pandas dataframe and filter to remove
133+
"""Read a pandas dataframe and filter to remove
133134
any data which is invalid for the scenario-under-test.
134135
135136
Data is invalid if it does not meet the constraints outlined in the scenario-under-test (Scenario).

0 commit comments

Comments
 (0)