Vasilis/docs #370
Vasilis/docs #370
Conversation
| "intervals, consider passing `inference='bootstrap'` or " | ||
| "`inference=econml.inference.BootstrapInference(n_bootstrap_samples=..., bootstrap_type=...)`, " | ||
| "as a keyword argument at the `fit` method of the CATE estimator.") | ||
| class BootstrapEstimator(bootstrap.BootstrapEstimator): |
There was a problem hiding this comment.
I thought you had previously mentioned liking the ease of use for wrapping sklearn estimators as well - do we really want to deprecate that? It seems like a generally useful utility.
There was a problem hiding this comment.
We'll still maintain the estimator in the code. But I think it's important for the users of the econml library to know that this is not the way to use the estimator with our cate estimates and that they shouldn't be using this class directly (we already had some users face this). So I do think we should make it a private class. One can still access it as econml.inference._bootstrap.BootstrapEstimator
| .. testcode:: | ||
| :hide: | ||
|
|
||
| # Our classes that derive from sklearn ones sometimes include | ||
| # inherited docstrings that have embedded doctests; we need the following imports | ||
| # so that they don't break. | ||
|
|
||
| import numpy as np | ||
| from sklearn.linear_model import lasso_path | ||
|
|
There was a problem hiding this comment.
I think these should only need to be imported once.
| .. testcode:: | |
| :hide: | |
| # Our classes that derive from sklearn ones sometimes include | |
| # inherited docstrings that have embedded doctests; we need the following imports | |
| # so that they don't break. | |
| import numpy as np | |
| from sklearn.linear_model import lasso_path |
There was a problem hiding this comment.
Unforutnately now that each class is in a separate autosummary page, we need this to be on each page. We can no longer just put it at the top of the file for instance.
| .. testcode:: | ||
| :hide: | ||
|
|
||
| # Our classes that derive from sklearn ones sometimes include | ||
| # inherited docstrings that have embedded doctests; we need the following imports | ||
| # so that they don't break. | ||
|
|
||
| import numpy as np | ||
| from sklearn.linear_model import lasso_path | ||
|
|
There was a problem hiding this comment.
Same here.
| .. testcode:: | |
| :hide: | |
| # Our classes that derive from sklearn ones sometimes include | |
| # inherited docstrings that have embedded doctests; we need the following imports | |
| # so that they don't break. | |
| import numpy as np | |
| from sklearn.linear_model import lasso_path |
| .. testcode:: | ||
| :hide: | ||
|
|
||
| # Our classes that derive from sklearn ones sometimes include | ||
| # inherited docstrings that have embedded doctests; we need the following imports | ||
| # so that they don't break. | ||
|
|
||
| import numpy as np | ||
| from sklearn.linear_model import lasso_path | ||
|
|
There was a problem hiding this comment.
And here.
| .. testcode:: | |
| :hide: | |
| # Our classes that derive from sklearn ones sometimes include | |
| # inherited docstrings that have embedded doctests; we need the following imports | |
| # so that they don't break. | |
| import numpy as np | |
| from sklearn.linear_model import lasso_path |
| .. testcode:: | ||
| :hide: | ||
|
|
||
| # Our classes that derive from sklearn ones sometimes include | ||
| # inherited docstrings that have embedded doctests; we need the following imports | ||
| # so that they don't break. | ||
|
|
||
| import numpy as np | ||
| from sklearn.linear_model import lasso_path | ||
|
|
There was a problem hiding this comment.
And here
| .. testcode:: | |
| :hide: | |
| # Our classes that derive from sklearn ones sometimes include | |
| # inherited docstrings that have embedded doctests; we need the following imports | |
| # so that they don't break. | |
| import numpy as np | |
| from sklearn.linear_model import lasso_path |
Most of the actual import paths did not change because the name of the folder is rhe name of the previous file and all public classes of each folder are included in the init |
| @@ -292,7 +292,7 @@ def test_stratify_orthoiv(self): | |||
| X = np.array([1, 1, 2, 2, 1, 2, 1, 2]).reshape(-1, 1) | |||
| est = LinearIntentToTreatDRIV(model_Y_X=LinearRegression(), model_T_XZ=LogisticRegression(), | |||
| flexible_model_effect=LinearRegression(), cv=2) | |||
| inference = BootstrapInference(n_bootstrap_samples=20) | |||
| inference = BootstrapInference(n_bootstrap_samples=20, n_jobs=-1, verbose=3) | |||
There was a problem hiding this comment.
Should we be testing that the output is more verbose in this case?
There was a problem hiding this comment.
Not sure how to do that easily. I’d say lets postpone
changing the doc structure