jrpybestpracccc 0.1.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. jrpybestpracccc/__init__.py +3 -0
  2. jrpybestpracccc/__version__.py +1 -0
  3. jrpybestpracccc/extra_scripts/example_projects/bad_project/.gitignore +3 -0
  4. jrpybestpracccc/extra_scripts/example_projects/bad_project/data/.gitignore +0 -0
  5. jrpybestpracccc/extra_scripts/example_projects/bad_project/experiment.ipynb +193 -0
  6. jrpybestpracccc/extra_scripts/example_projects/bad_project/setup.cfg +7 -0
  7. jrpybestpracccc/extra_scripts/example_projects/good_project/.gitignore +3 -0
  8. jrpybestpracccc/extra_scripts/example_projects/good_project/data/.gitignore +0 -0
  9. jrpybestpracccc/extra_scripts/example_projects/good_project/experiment.ipynb +1024 -0
  10. jrpybestpracccc/extra_scripts/example_projects/good_project/setup.cfg +7 -0
  11. jrpybestpracccc/extra_scripts/example_projects/good_project/src/__init__.py +0 -0
  12. jrpybestpracccc/extra_scripts/example_projects/good_project/src/config/filenames.py +3 -0
  13. jrpybestpracccc/extra_scripts/example_projects/good_project/src/config/theme.py +147 -0
  14. jrpybestpracccc/extra_scripts/example_projects/good_project/src/data/__init__.py +2 -0
  15. jrpybestpracccc/extra_scripts/example_projects/good_project/src/data/preprocessing.py +341 -0
  16. jrpybestpracccc/extra_scripts/example_projects/good_project/src/data/storage.py +99 -0
  17. jrpybestpracccc/extra_scripts/example_projects/good_project/src/modelling/__init__.py +4 -0
  18. jrpybestpracccc/extra_scripts/example_projects/good_project/src/modelling/ingredients.py +58 -0
  19. jrpybestpracccc/extra_scripts/example_projects/good_project/src/modelling/predictions.py +18 -0
  20. jrpybestpracccc/extra_scripts/example_projects/good_project/src/modelling/scoring.py +18 -0
  21. jrpybestpracccc/extra_scripts/example_projects/good_project/src/modelling/training.py +42 -0
  22. jrpybestpracccc-0.1.1.dist-info/METADATA +14 -0
  23. jrpybestpracccc-0.1.1.dist-info/RECORD +24 -0
  24. jrpybestpracccc-0.1.1.dist-info/WHEEL +4 -0
@@ -0,0 +1,42 @@
1
+ """Functions associated with training the model"""
2
+
3
+ from sklearn.model_selection import train_test_split
4
+
5
+
6
+ def train_model(model, x, y):
7
+ """Train the model using the training data
8
+
9
+ :parameters:
10
+ model: sklearn model or pipeline object
11
+ Model or pipeline for training
12
+ x: 2-D data structure
13
+ Covariates for training
14
+ y: 1-D data structure
15
+ Target variable to predict
16
+
17
+ :returns:
18
+ Sklearn model or pipeline object after training
19
+ """
20
+ model.fit(x, y)
21
+ return model
22
+
23
+
24
+ def create_test_data(x, y, test_size=0.2):
25
+ """
26
+ Split up the data into a training set and (unseen) test set
27
+
28
+ parameters
29
+ ----------
30
+ x: pd.DataFrame
31
+ DataFrame with the covariates (predictors)
32
+ y: pd.Series | np.array | list
33
+ Array-like object with the response (target) variable
34
+ test_size: float
35
+ Proportion of data to allocate to the test set
36
+
37
+ returns
38
+ -------
39
+ (x_train, x_test, y_train, y_test)
40
+ pd.DataFrame objects with the split data
41
+ """
42
+ return train_test_split(x, y, test_size=test_size)
@@ -0,0 +1,14 @@
1
+ Metadata-Version: 2.1
2
+ Name: jrpybestpracccc
3
+ Version: 0.1.1
4
+ Summary: Jumping Rivers: Python Best Practices
5
+ Author: Jumping Rivers
6
+ Author-email: info@jumpingrivers.com
7
+ Requires-Python: >=3.10
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: Programming Language :: Python :: 3.10
10
+ Classifier: Programming Language :: Python :: 3.11
11
+ Classifier: Programming Language :: Python :: 3.12
12
+ Requires-Dist: jrpybestprac (>=0.1.3)
13
+ Requires-Dist: plotly (>=6.0.0)
14
+ Requires-Dist: scikit-learn (>=1.1.1)
@@ -0,0 +1,24 @@
1
+ jrpybestpracccc/__init__.py,sha256=xm2VrLp8imA_uc5rC3nguv7zUGrOvc_H7CzQnJsgjYA,90
2
+ jrpybestpracccc/__version__.py,sha256=rnObPjuBcEStqSO0S6gsdS_ot8ITOQjVj_-P1LUUYpg,22
3
+ jrpybestpracccc/extra_scripts/example_projects/bad_project/.gitignore,sha256=ToVK1Gdb2z1pnFn4LEx7jvRfSP7CIRGYgIWzay__veM,21
4
+ jrpybestpracccc/extra_scripts/example_projects/bad_project/data/.gitignore,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
5
+ jrpybestpracccc/extra_scripts/example_projects/bad_project/experiment.ipynb,sha256=0lrR7fEPYcXsBMc8MMxWytrjySKlx87fKWub1h4TZKI,4957
6
+ jrpybestpracccc/extra_scripts/example_projects/bad_project/setup.cfg,sha256=bsWg9yPrH_gMo3556kkBuxCLZrG0c-SteFax6AWms8E,163
7
+ jrpybestpracccc/extra_scripts/example_projects/good_project/.gitignore,sha256=ToVK1Gdb2z1pnFn4LEx7jvRfSP7CIRGYgIWzay__veM,21
8
+ jrpybestpracccc/extra_scripts/example_projects/good_project/data/.gitignore,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
9
+ jrpybestpracccc/extra_scripts/example_projects/good_project/experiment.ipynb,sha256=bS0MsE7FdaCRsFw7uBqiwm258fZkdGi7L6JI3ANd_Cg,4713603
10
+ jrpybestpracccc/extra_scripts/example_projects/good_project/setup.cfg,sha256=bsWg9yPrH_gMo3556kkBuxCLZrG0c-SteFax6AWms8E,163
11
+ jrpybestpracccc/extra_scripts/example_projects/good_project/src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
12
+ jrpybestpracccc/extra_scripts/example_projects/good_project/src/config/filenames.py,sha256=UtPoQiVt2SaX10evNrgjxM8rvTE2aPAuKFYxzh0FeFY,64
13
+ jrpybestpracccc/extra_scripts/example_projects/good_project/src/config/theme.py,sha256=N9thMpd2Y6BKjFQT9vzMfI9hoLHhqp_yExzks1l4His,4388
14
+ jrpybestpracccc/extra_scripts/example_projects/good_project/src/data/__init__.py,sha256=WtZbe2gVm-K3kgeuuvNDxySp5HvBWM_05ExrEdqolFk,119
15
+ jrpybestpracccc/extra_scripts/example_projects/good_project/src/data/preprocessing.py,sha256=6d8rNwCMSjzNReX1JC0zjSOgB05IAb8U33uKpzZzck4,8682
16
+ jrpybestpracccc/extra_scripts/example_projects/good_project/src/data/storage.py,sha256=egB2QKUnaxIGdGTCGmyYSmtpLj_mfEbNTjAHU4l_KfU,2395
17
+ jrpybestpracccc/extra_scripts/example_projects/good_project/src/modelling/__init__.py,sha256=azy9syg-PRLVw9aMBmchEkTk2Ckx1-QNkTkcInSr75U,202
18
+ jrpybestpracccc/extra_scripts/example_projects/good_project/src/modelling/ingredients.py,sha256=Qsi8Y1ZaZ3xCggUempUfMShFnvF4tCkqaNqPd4fB8Bc,1518
19
+ jrpybestpracccc/extra_scripts/example_projects/good_project/src/modelling/predictions.py,sha256=7oCfe2_Ie8SE9fyQuXiD4qpigosf1mKKsNvhbOr17rU,455
20
+ jrpybestpracccc/extra_scripts/example_projects/good_project/src/modelling/scoring.py,sha256=0rZTwtBFg2QOnX-t8w7aaotGT19-JpC9pgnVVIaGNnA,442
21
+ jrpybestpracccc/extra_scripts/example_projects/good_project/src/modelling/training.py,sha256=v6Do-zImZuqRjIYtjwRsoIGfa2MWqdMDXlcZ9Q2FYXo,1070
22
+ jrpybestpracccc-0.1.1.dist-info/METADATA,sha256=0al0S6SZvoNXkpzKW9-v5Wdku8SehRhFbVqh6i681mU,499
23
+ jrpybestpracccc-0.1.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
24
+ jrpybestpracccc-0.1.1.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: poetry-core 1.9.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any