Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Restructuring the examples section #785

Merged
merged 13 commits into from
Sep 30, 2019
+214 −71
Merged

[WIP] Restructuring the examples section #785

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
86ee9b2
First commit of basic examples
ArlindKadra Sep 9, 2019
29d47a4
Fixing typo
ArlindKadra Sep 9, 2019
8e29a9e
Fixing pep8 violation and typo in extended examples
ArlindKadra Sep 10, 2019
ee9413d
Small fix to the original examples and initial idea of the basic exam…
ArlindKadra Sep 10, 2019
277a876
re-organize again to have the examples sorted correctly
mfeurer Sep 27, 2019
f5fe20d
remove accidentally submitted files
mfeurer Sep 27, 2019
3312e32
fix mistake I made when shuffling around files
mfeurer Sep 27, 2019
b34e048
add example placeholders
mfeurer Sep 27, 2019
780972d
minor
mfeurer Sep 27, 2019
25d59d4
rename example files so they are executed during documentation constr…
mfeurer Sep 27, 2019
b85bd42
Temporary solution to the failing flake8 check
ArlindKadra Sep 30, 2019
2df5b5a
Fixing typo
ArlindKadra Sep 30, 2019
f6d4880
Adding more info for the future
ArlindKadra Sep 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
re-organize again to have the examples sorted correctly
  • Loading branch information
@mfeurer
mfeurer committed Sep 27, 2019
commit 277a8769adf6efc1f0bd3bdeb1a87aa0f43740af
5 changes: 5 additions & 0 deletions examples/10_showcase/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Showcase examples
=================

These are short examples demonstrating advanced features of OpenML-Python on a high level. To get
an in-depth understanding of the methods we refer to the in-depth examples
0 examples/basic/README.txt → examples/20_basic/README.txt
View file
Open in desktop
File renamed without changes.
0 examples/basic/introduction_tutorial.py → examples/20_basic/introduction_tutorial.py
View file
Open in desktop
File renamed without changes.
0 examples/basic/simple_datasets_tutorial.py → ...ples/20_basic/simple_datasets_tutorial.py
View file
Open in desktop
File renamed without changes.
0 ...s/basic/simple_flows_and_runs_tutorial.py → ...0_basic/simple_flows_and_runs_tutorial.py
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion examples/basic/simple_tasks_tutorial.py → examples/20_basic/simple_tasks_tutorial.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Tasks
=====

A basic tutorial on how to list and download tasks.
A 20_basic tutorial on how to list and download tasks.
"""
import openml
from pprint import pprint
Expand Down
0 examples/extended/README.txt → examples/30_extended/README.txt
View file
Open in desktop
File renamed without changes.
0 examples/extended/create_upload_tutorial.py → ...les/30_extended/create_upload_tutorial.py
View file
Open in desktop
File renamed without changes.
0 examples/extended/datasets_tutorial.py → examples/30_extended/datasets_tutorial.py
View file
Open in desktop
File renamed without changes.
0 ...es/extended/fetch_evaluations_tutorial.py → ...30_extended/fetch_evaluations_tutorial.py
View file
Open in desktop
File renamed without changes.
0 examples/extended/flows_and_runs_tutorial.py → ...es/30_extended/flows_and_runs_tutorial.py
View file
Open in desktop
File renamed without changes.
38 changes: 38 additions & 0 deletions examples/30_extended/myrun/description.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?xml version="1.0" encoding="utf-8"?>
<oml:run xmlns:oml="http://openml.org/openml">
<oml:task_id>6</oml:task_id>
<oml:flow_id></oml:flow_id>
<oml:parameter_setting></oml:parameter_setting>
<oml:tag>openml-python</oml:tag>
<oml:tag>Sklearn_0.21.2.</oml:tag>
<oml:output_data>
<oml:evaluation repeat="0" fold="0">
<oml:name>usercpu_time_millis_training</oml:name>
<oml:value>30.206837999998015</oml:value>
</oml:evaluation>
<oml:evaluation repeat="0" fold="0">
<oml:name>wall_clock_time_millis_training</oml:name>
<oml:value>30.39407730102539</oml:value>
</oml:evaluation>
<oml:evaluation repeat="0" fold="0">
<oml:name>usercpu_time_millis_testing</oml:name>
<oml:value>7.382827000000702</oml:value>
</oml:evaluation>
<oml:evaluation repeat="0" fold="0">
<oml:name>usercpu_time_millis</oml:name>
<oml:value>37.58966499999872</oml:value>
</oml:evaluation>
<oml:evaluation repeat="0" fold="0">
<oml:name>wall_clock_time_millis_testing</oml:name>
<oml:value>7.469415664672852</oml:value>
</oml:evaluation>
<oml:evaluation repeat="0" fold="0">
<oml:name>wall_clock_time_millis</oml:name>
<oml:value>37.86349296569824</oml:value>
</oml:evaluation>
<oml:evaluation repeat="0" fold="0">
<oml:name>predictive_accuracy</oml:name>
<oml:value>0.8108108108108109</oml:value>
</oml:evaluation>
</oml:output_data>
</oml:run>
279 changes: 279 additions & 0 deletions examples/30_extended/myrun/flow.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,279 @@
<oml:flow xmlns:oml="http://openml.org/openml">
<oml:name>sklearn.pipeline.Pipeline(Preprocessing=sklearn.compose._column_transformer.ColumnTransformer(Nominal=sklearn.pipeline.Pipeline(Imputer=sklearn.impute._base.SimpleImputer,Encoder=sklearn.preprocessing._encoders.OneHotEncoder)),Classifier=sklearn.ensemble.forest.RandomForestClassifier)</oml:name>
<oml:custom_name>sklearn.Pipeline(ColumnTransformer,RandomForestClassifier)</oml:custom_name>
<oml:class_name>sklearn.pipeline.Pipeline</oml:class_name>
<oml:external_version>openml==0.10.1dev,sklearn==0.21.2</oml:external_version>
<oml:description>Automatically created scikit-learn flow.</oml:description>
<oml:language>English</oml:language>
<oml:dependencies>sklearn==0.21.2
numpy&gt;=1.6.1
scipy&gt;=0.9</oml:dependencies>
<oml:parameter>
<oml:name>memory</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>steps</oml:name>
<oml:default_value>[{"oml-python:serialized_object": "component_reference", "value": {"key": "Preprocessing", "step_name": "Preprocessing"}}, {"oml-python:serialized_object": "component_reference", "value": {"key": "Classifier", "step_name": "Classifier"}}]</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>verbose</oml:name>
<oml:default_value>false</oml:default_value>
</oml:parameter>
<oml:component>
<oml:identifier>Preprocessing</oml:identifier>
<oml:flow xmlns:oml="http://openml.org/openml">
<oml:name>sklearn.compose._column_transformer.ColumnTransformer(Nominal=sklearn.pipeline.Pipeline(Imputer=sklearn.impute._base.SimpleImputer,Encoder=sklearn.preprocessing._encoders.OneHotEncoder))</oml:name>
<oml:custom_name>sklearn.ColumnTransformer</oml:custom_name>
<oml:class_name>sklearn.compose._column_transformer.ColumnTransformer</oml:class_name>
<oml:external_version>openml==0.10.1dev,sklearn==0.21.2</oml:external_version>
<oml:description>Automatically created scikit-learn flow.</oml:description>
<oml:language>English</oml:language>
<oml:dependencies>sklearn==0.21.2
numpy&gt;=1.6.1
scipy&gt;=0.9</oml:dependencies>
<oml:parameter>
<oml:name>n_jobs</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>remainder</oml:name>
<oml:default_value>"drop"</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>sparse_threshold</oml:name>
<oml:default_value>0.3</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>transformer_weights</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>transformers</oml:name>
<oml:default_value>[{"oml-python:serialized_object": "component_reference", "value": {"key": "Nominal", "step_name": "Nominal", "argument_1": [0, 1, 2, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 35, 36, 37]}}]</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>verbose</oml:name>
<oml:default_value>false</oml:default_value>
</oml:parameter>
<oml:component>
<oml:identifier>Nominal</oml:identifier>
<oml:flow xmlns:oml="http://openml.org/openml">
<oml:name>sklearn.pipeline.Pipeline(Imputer=sklearn.impute._base.SimpleImputer,Encoder=sklearn.preprocessing._encoders.OneHotEncoder)</oml:name>
<oml:custom_name>sklearn.Pipeline(SimpleImputer,OneHotEncoder)</oml:custom_name>
<oml:class_name>sklearn.pipeline.Pipeline</oml:class_name>
<oml:external_version>openml==0.10.1dev,sklearn==0.21.2</oml:external_version>
<oml:description>Automatically created scikit-learn flow.</oml:description>
<oml:language>English</oml:language>
<oml:dependencies>sklearn==0.21.2
numpy&gt;=1.6.1
scipy&gt;=0.9</oml:dependencies>
<oml:parameter>
<oml:name>memory</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>steps</oml:name>
<oml:default_value>[{"oml-python:serialized_object": "component_reference", "value": {"key": "Imputer", "step_name": "Imputer"}}, {"oml-python:serialized_object": "component_reference", "value": {"key": "Encoder", "step_name": "Encoder"}}]</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>verbose</oml:name>
<oml:default_value>false</oml:default_value>
</oml:parameter>
<oml:component>
<oml:identifier>Imputer</oml:identifier>
<oml:flow xmlns:oml="http://openml.org/openml">
<oml:name>sklearn.impute._base.SimpleImputer</oml:name>
<oml:custom_name>sklearn.SimpleImputer</oml:custom_name>
<oml:class_name>sklearn.impute._base.SimpleImputer</oml:class_name>
<oml:external_version>openml==0.10.1dev,sklearn==0.21.2</oml:external_version>
<oml:description>Automatically created scikit-learn flow.</oml:description>
<oml:language>English</oml:language>
<oml:dependencies>sklearn==0.21.2
numpy&gt;=1.6.1
scipy&gt;=0.9</oml:dependencies>
<oml:parameter>
<oml:name>add_indicator</oml:name>
<oml:default_value>false</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>copy</oml:name>
<oml:default_value>true</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>fill_value</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>missing_values</oml:name>
<oml:default_value>NaN</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>strategy</oml:name>
<oml:default_value>"most_frequent"</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>verbose</oml:name>
<oml:default_value>0</oml:default_value>
</oml:parameter>
<oml:tag>openml-python</oml:tag>
<oml:tag>sklearn</oml:tag>
<oml:tag>scikit-learn</oml:tag>
<oml:tag>python</oml:tag>
<oml:tag>sklearn_0.21.2</oml:tag>
</oml:flow>
</oml:component>
<oml:component>
<oml:identifier>Encoder</oml:identifier>
<oml:flow xmlns:oml="http://openml.org/openml">
<oml:name>sklearn.preprocessing._encoders.OneHotEncoder</oml:name>
<oml:custom_name>sklearn.OneHotEncoder</oml:custom_name>
<oml:class_name>sklearn.preprocessing._encoders.OneHotEncoder</oml:class_name>
<oml:external_version>openml==0.10.1dev,sklearn==0.21.2</oml:external_version>
<oml:description>Automatically created scikit-learn flow.</oml:description>
<oml:language>English</oml:language>
<oml:dependencies>sklearn==0.21.2
numpy&gt;=1.6.1
scipy&gt;=0.9</oml:dependencies>
<oml:parameter>
<oml:name>categorical_features</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>categories</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>drop</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>dtype</oml:name>
<oml:default_value>{"oml-python:serialized_object": "type", "value": "np.float64"}</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>handle_unknown</oml:name>
<oml:default_value>"ignore"</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>n_values</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>sparse</oml:name>
<oml:default_value>false</oml:default_value>
</oml:parameter>
<oml:tag>openml-python</oml:tag>
<oml:tag>sklearn</oml:tag>
<oml:tag>scikit-learn</oml:tag>
<oml:tag>python</oml:tag>
<oml:tag>sklearn_0.21.2</oml:tag>
</oml:flow>
</oml:component>
<oml:tag>openml-python</oml:tag>
<oml:tag>sklearn</oml:tag>
<oml:tag>scikit-learn</oml:tag>
<oml:tag>python</oml:tag>
<oml:tag>sklearn_0.21.2</oml:tag>
</oml:flow>
</oml:component>
<oml:tag>openml-python</oml:tag>
<oml:tag>sklearn</oml:tag>
<oml:tag>scikit-learn</oml:tag>
<oml:tag>python</oml:tag>
<oml:tag>sklearn_0.21.2</oml:tag>
</oml:flow>
</oml:component>
<oml:component>
<oml:identifier>Classifier</oml:identifier>
<oml:flow xmlns:oml="http://openml.org/openml">
<oml:name>sklearn.ensemble.forest.RandomForestClassifier</oml:name>
<oml:custom_name>sklearn.RandomForestClassifier</oml:custom_name>
<oml:class_name>sklearn.ensemble.forest.RandomForestClassifier</oml:class_name>
<oml:external_version>openml==0.10.1dev,sklearn==0.21.2</oml:external_version>
<oml:description>Automatically created scikit-learn flow.</oml:description>
<oml:language>English</oml:language>
<oml:dependencies>sklearn==0.21.2
numpy&gt;=1.6.1
scipy&gt;=0.9</oml:dependencies>
<oml:parameter>
<oml:name>bootstrap</oml:name>
<oml:default_value>true</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>class_weight</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>criterion</oml:name>
<oml:default_value>"gini"</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>max_depth</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>max_features</oml:name>
<oml:default_value>"auto"</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>max_leaf_nodes</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>min_impurity_decrease</oml:name>
<oml:default_value>0.0</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>min_impurity_split</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>min_samples_leaf</oml:name>
<oml:default_value>1</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>min_samples_split</oml:name>
<oml:default_value>2</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>min_weight_fraction_leaf</oml:name>
<oml:default_value>0.0</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>n_estimators</oml:name>
<oml:default_value>10</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>n_jobs</oml:name>
<oml:default_value>null</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>oob_score</oml:name>
<oml:default_value>false</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>random_state</oml:name>
<oml:default_value>32376</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>verbose</oml:name>
<oml:default_value>0</oml:default_value>
</oml:parameter>
<oml:parameter>
<oml:name>warm_start</oml:name>
<oml:default_value>false</oml:default_value>
</oml:parameter>
<oml:tag>openml-python</oml:tag>
<oml:tag>sklearn</oml:tag>
<oml:tag>scikit-learn</oml:tag>
<oml:tag>python</oml:tag>
<oml:tag>sklearn_0.21.2</oml:tag>
</oml:flow>
</oml:component>
<oml:tag>openml-python</oml:tag>
<oml:tag>sklearn</oml:tag>
<oml:tag>scikit-learn</oml:tag>
<oml:tag>python</oml:tag>
<oml:tag>sklearn_0.21.2</oml:tag>
</oml:flow>
Binary file added examples/30_extended/myrun/model.pkl
View file
Open in desktop
Binary file not shown.
Loading