aidflow 3.0.4__tar.gz → 3.0.6__tar.gz

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.
@@ -1,13 +1,13 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: aidflow
3
- Version: 3.0.4
3
+ Version: 3.0.6
4
4
  Summary: Pipeline execution framework
5
5
  Project-URL: Homepage, https://github.com/aigensys-labs/aidflow
6
+ Project-URL: Documentation, https://aidflow.aigensys.com/
6
7
  Project-URL: Repository, https://github.com/aigensys-labs/aidflow
7
8
  Project-URL: Bug Tracker, https://github.com/aigensys-labs/aidflow/issues
8
9
  Author-email: AIGENSYS <info@aigensys.com>
9
10
  License: FSL-1.1-Apache-2.0
10
- License-File: LICENSE
11
11
  Classifier: Operating System :: OS Independent
12
12
  Classifier: Programming Language :: Python :: 3
13
13
  Classifier: Programming Language :: Python :: 3.13
@@ -53,6 +53,25 @@ AIDflow eliminates the friction between rapid experimental prototyping and enter
53
53
 
54
54
  ---
55
55
 
56
+ ## The Three-Layer Abstraction (The "Super-Gear")
57
+
58
+ AIDflow decouples the user's intent from the mathematical execution using a three-layer stack. This allows us to change the underlying ML algorithm without ever breaking the User Interface.
59
+
60
+ ### Layer 1: The Worker (Interface)
61
+ * **Role:** The Orchestrator.
62
+ * **Responsibility:** Handles UI, input validation, and state registration.
63
+ * **User Experience:** *"I want to clean my data"* → `ctx.data.fe_cleaner()`.
64
+
65
+ ### Layer 2: The Model (The Gear)
66
+ * **Role:** The Adapter.
67
+ * **Responsibility:** Decouples the Worker from the Fitter. It manages "Fit Options," allowing a single Worker to support multiple different algorithms (e.g., switching between a Sparse GLM and an ElasticNet).
68
+
69
+ ### Layer 3: The Fitter (The Engine)
70
+ * **Role:** The Compute Engine.
71
+ * **Responsibility:** Pure mathematical execution. This is where the actual matrix multiplication, optimization, and fitting occur. It has no knowledge of the UI or the Project Context—it only knows data and parameters.
72
+
73
+ --
74
+
56
75
  ## Quick Start
57
76
 
58
77
  ### Installation
@@ -71,11 +90,11 @@ import aidflow as aid
71
90
  ctx = aid.ProjectContext()
72
91
 
73
92
  ctx.genesis(
74
- project = 'test',
75
- input_data = 'test.csv',
76
- target = 'target',
77
- yy_mm = 'decision_date',
78
- yy_mm_format = '%d%b%y'
93
+ project = 'test',
94
+ input_data = 'test.csv',
95
+ target = 'target',
96
+ yy_mm = 'decision_date',
97
+ yy_mm_format = '%d%b%y'
79
98
  )
80
99
  ctx.params()
81
100
  ```
@@ -138,10 +157,10 @@ ctx.workers.data_loader.fitter.params
138
157
  Direct choice and parametrization of internal fitter:
139
158
 
140
159
  ```python
141
- fx = ctx.registry.data_loader[0]
160
+ fx = ctx.workers.data_loader.fitters[0]
142
161
  prm = dict(
143
- flow_vars = ['target1', 'target2'],
144
- columns_subset = ['fe1', 'fe2']
162
+ low_vars = ['target1', 'target2'],
163
+ columns_subset = ['fe1', 'fe2']
145
164
  )
146
165
  loader = ctx.workers.data_loader(fx_choice = fx, fx_params = prm)
147
166
  ```
@@ -151,7 +170,7 @@ In the experimenting phase when various targets might be under testing\
151
170
 
152
171
  ```python
153
172
  cfg = dict(
154
- target = 'target2',
173
+ target = 'target2',
155
174
  )
156
175
  woe = ctx.workers.data_loader(fx_config = cfg)
157
176
  ```
@@ -34,6 +34,25 @@ AIDflow eliminates the friction between rapid experimental prototyping and enter
34
34
 
35
35
  ---
36
36
 
37
+ ## The Three-Layer Abstraction (The "Super-Gear")
38
+
39
+ AIDflow decouples the user's intent from the mathematical execution using a three-layer stack. This allows us to change the underlying ML algorithm without ever breaking the User Interface.
40
+
41
+ ### Layer 1: The Worker (Interface)
42
+ * **Role:** The Orchestrator.
43
+ * **Responsibility:** Handles UI, input validation, and state registration.
44
+ * **User Experience:** *"I want to clean my data"* → `ctx.data.fe_cleaner()`.
45
+
46
+ ### Layer 2: The Model (The Gear)
47
+ * **Role:** The Adapter.
48
+ * **Responsibility:** Decouples the Worker from the Fitter. It manages "Fit Options," allowing a single Worker to support multiple different algorithms (e.g., switching between a Sparse GLM and an ElasticNet).
49
+
50
+ ### Layer 3: The Fitter (The Engine)
51
+ * **Role:** The Compute Engine.
52
+ * **Responsibility:** Pure mathematical execution. This is where the actual matrix multiplication, optimization, and fitting occur. It has no knowledge of the UI or the Project Context—it only knows data and parameters.
53
+
54
+ --
55
+
37
56
  ## Quick Start
38
57
 
39
58
  ### Installation
@@ -52,11 +71,11 @@ import aidflow as aid
52
71
  ctx = aid.ProjectContext()
53
72
 
54
73
  ctx.genesis(
55
- project = 'test',
56
- input_data = 'test.csv',
57
- target = 'target',
58
- yy_mm = 'decision_date',
59
- yy_mm_format = '%d%b%y'
74
+ project = 'test',
75
+ input_data = 'test.csv',
76
+ target = 'target',
77
+ yy_mm = 'decision_date',
78
+ yy_mm_format = '%d%b%y'
60
79
  )
61
80
  ctx.params()
62
81
  ```
@@ -119,10 +138,10 @@ ctx.workers.data_loader.fitter.params
119
138
  Direct choice and parametrization of internal fitter:
120
139
 
121
140
  ```python
122
- fx = ctx.registry.data_loader[0]
141
+ fx = ctx.workers.data_loader.fitters[0]
123
142
  prm = dict(
124
- flow_vars = ['target1', 'target2'],
125
- columns_subset = ['fe1', 'fe2']
143
+ low_vars = ['target1', 'target2'],
144
+ columns_subset = ['fe1', 'fe2']
126
145
  )
127
146
  loader = ctx.workers.data_loader(fx_choice = fx, fx_params = prm)
128
147
  ```
@@ -132,7 +151,7 @@ In the experimenting phase when various targets might be under testing\
132
151
 
133
152
  ```python
134
153
  cfg = dict(
135
- target = 'target2',
154
+ target = 'target2',
136
155
  )
137
156
  woe = ctx.workers.data_loader(fx_config = cfg)
138
157
  ```
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "aidflow"
7
- version = "3.0.4"
7
+ version = "3.0.6"
8
8
  description = "Pipeline execution framework"
9
9
  readme = "README.md"
10
10
  license = { text = "FSL-1.1-Apache-2.0" }
@@ -22,5 +22,6 @@ classifiers = [
22
22
 
23
23
  [project.urls]
24
24
  Homepage = "https://github.com/aigensys-labs/aidflow"
25
+ Documentation = "https://aidflow.aigensys.com/"
25
26
  Repository = "https://github.com/aigensys-labs/aidflow"
26
27
  "Bug Tracker" = "https://github.com/aigensys-labs/aidflow/issues"
aidflow-3.0.4/LICENSE DELETED
@@ -1,56 +0,0 @@
1
- # Functional Source License, Version 1.1, Apache 2.0 Future License
2
-
3
- ## Abbreviation
4
- FSL-1.1-Apache-2.0
5
-
6
- ## Notice
7
- Copyright 2026 AIGENSYS s.r.o., Ing. Michal Ricar, Ph.D. and AIDflow contributors
8
-
9
- ## Terms and Conditions
10
-
11
- ### Licensor ("We")
12
- The party offering the Software under these Terms and Conditions.
13
-
14
- ### The Software
15
- The "Software" is each version of the software that we make available under these Terms and Conditions, as indicated by our inclusion of these Terms and Conditions with the Software.
16
-
17
- ### License Grant
18
- Subject to your compliance with this License Grant and the Patents, Redistribution and Trademark clauses below, we hereby grant you the right to use, copy, modify, create derivative works, publicly perform, publicly display and redistribute the Software for any Permitted Purpose identified below.
19
-
20
- ### Permitted Purpose
21
- A Permitted Purpose is any purpose other than a Competing Use. A Competing Use means making the Software available to others in a commercial product or service that:
22
- 1. substitutes for the Software;
23
- 2. substitutes for any other product or service we offer using the Software that exists as of the date we make the Software available; or
24
- 3. offers the same or substantially similar functionality as the Software.
25
-
26
- Permitted Purposes specifically include using the Software:
27
- 1. for your internal use and access;
28
- 2. for non-commercial education;
29
- 3. for non-commercial research; and
30
- 4. in connection with professional services that you provide to a licensee using the Software in accordance with these Terms and Conditions.
31
-
32
- ### Patents
33
- To the extent your use for a Permitted Purpose would necessarily infringe our patents, the license grant above includes a license under our patents. If you make a claim against any party that the Software infringes or contributes to the infringement of any patent, then your patent license to the Software ends immediately.
34
-
35
- ### Redistribution
36
- The Terms and Conditions apply to all copies, modifications and derivatives of the Software.
37
-
38
- If you redistribute any copies, modifications or derivatives of the Software, you must include a copy of or a link to these Terms and Conditions and not remove any copyright notices provided in or with the Software.
39
-
40
- ### Disclaimer
41
- THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
42
-
43
- IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
44
-
45
- ### Trademarks
46
- Except for displaying the License Details and identifying us as the origin of the Software, you have no right under these Terms and Conditions to use our trademarks, trade names, service marks or product names.
47
-
48
- ## Grant of Future License
49
-
50
- We hereby irrevocably grant you an additional license to use the Software under the Apache License, Version 2.0 that is effective on the second anniversary of the date we make the Software available. On or after that date, you may use the Software under the Apache License, Version 2.0, in which case the following will apply:
51
-
52
- > Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:
53
- >
54
- > http://www.apache.org/licenses/LICENSE-2.0
55
- >
56
- > Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
File without changes
File without changes