Merge pull request #135 from BCG-Gamma/hotfix/correct_readme_code

Correct facet api arguments in README & notebook
BCG-X-Official · Oct 29, 2020 · a3a2bf5 · a3a2bf5
2 parents b367f1e + 5e2bdf3
commit a3a2bf5
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/README.rst b/README.rst
@@ -88,7 +88,7 @@ Enhanced machine learning workflow
     )
 
     # create FACET sample object
-    boston_obs = Sample(observations=df, target="MEDIAN_HOUSE_PRICE")
+    boston_obs = Sample(observations=df, target_name="MEDIAN_HOUSE_PRICE")
 
     # create pipeline for random forest regressor
     rforest_reg = RegressorPipelineDF(regressor=RandomForestRegressorDF(random_state=42))
@@ -201,13 +201,13 @@ Model Simulation
     ).fit(sample=boston_obs)
 
     SIM_FEAT = "LSTAT"
-    simulator = UnivariateUpliftSimulator(crossfit=ranker.best_model_crossfit_, n_jobs=3)
+    simulator = UnivariateUpliftSimulator(crossfit=boot_crossfit, n_jobs=3)
 
     # split the simulation range into equal sized partitions
     partitioner = ContinuousRangePartitioner()
 
     # run the simulation
-    simulation = simulator.simulate_feature(name=SIM_FEAT, partitioner=partitioner)
+    simulation = simulator.simulate_feature(feature_name=SIM_FEAT, partitioner=partitioner)
 
     # visualise results
     SimulationDrawer().draw(data=simulation, title=SIM_FEAT)

diff --git a/_static/simulation_output.png b/_static/simulation_output.png
diff --git a/sphinx/auxiliary/Boston_getting_started_example.ipynb b/sphinx/auxiliary/Boston_getting_started_example.ipynb
@@ -595,7 +595,7 @@
     "partitioner = ContinuousRangePartitioner()\n",
     "\n",
     "# run the simulation\n",
-    "simulation = simulator.simulate_feature(name=SIM_FEAT, partitioner=partitioner)\n",
+    "simulation = simulator.simulate_feature(feature_name=SIM_FEAT, partitioner=partitioner)\n",
     "\n",
     "# visualise results\n",
     "SimulationDrawer().draw(data=simulation, title=SIM_FEAT)"

diff --git a/sphinx/source/_static/simulation_output.png b/sphinx/source/_static/simulation_output.png