fasttransform 0.0.1__tar.gz

fasttransform-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   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.

fasttransform-0.0.1/MANIFEST.in

@@ -0,0 +1,5 @@
+include settings.ini
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__

fasttransform-0.0.1/PKG-INFO

@@ -0,0 +1,296 @@
+Metadata-Version: 2.1
+Name: fasttransform
+Version: 0.0.1
+Summary: Transform is the main building block of data pipelines in fastai. And elsewhere if you want.
+Home-page: https://github.com/AnswerDotAI/fasttransform
+Author: Jeremy Howard and Rens Dimmendaal and Alexis Gallagher
+Author-email: info@fast.ai
+License: Apache Software License 2.0
+Keywords: nbdev jupyter notebook python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastcore
+Requires-Dist: plum-dispatch
+Provides-Extra: dev
+Requires-Dist: matplotlib; extra == "dev"
+Requires-Dist: numpy; extra == "dev"
+Requires-Dist: pandas; extra == "dev"
+
+# Welcome to fasttransform
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Installation
+
+Install latest from the GitHub
+[repository](https://github.com/AnswerDotAI/fasttransform):
+
+``` sh
+$ pip install git+https://github.com/AnswerDotAI/fasttransform.git
+```
+
+or from [pypi](https://pypi.org/project/fasttransform/):
+
+``` sh
+$ pip install fasttransform
+```
+
+## Quick start
+
+### Transform
+
+Transform is a class that lets you create reusable data transformations.
+You initialize a Transform by passing in or decorating a raw function.
+The Transform then provides an enhanced version of that function via
+`Transform.encodes`, which can be used in your data pipeline.
+
+It provides various conveniences:
+
+- **Reversibility**. You can collect the raw function and its inverse
+  into one transform object.
+- **Customized initialization** You can customize the exact behavior of
+  a transform function on initialization.
+- **Type-based mulitiple dispatch**. Transforms can specialize their
+  behavior based on the runtime types of their arguments.
+- **Type conversion/preservation**. Transforms help you maintain desired
+  return types.
+
+The simplest way to create a Transform is by decorating a function:
+
+``` python
+from fasttransform import Transform, Pipeline
+```
+
+``` python
+@Transform
+def add_one(x): 
+    return x + 1
+
+# Usage
+add_one(2)
+```
+
+    3
+
+### Reversibility
+
+To make a transform reversible, you provide the raw function and its
+inverse. This is useful in data pipelines where, for instance, you might
+want to normalize and then de-normalize numerical values, or encode to
+category indexes and then decode back to categories.
+
+``` python
+def enc(x): return x*2
+def dec(x): return x//2
+
+t = Transform(enc,dec)
+
+t(2), t.decode(2), t.decode(t(2))
+```
+
+    (4, 1, 2)
+
+### Customized initialization
+
+You can customize an individual Transform instance at initialization
+time, so that it can depend on aggregate properties of the data set.
+
+Here we define a z-score normalization Transform by defining `encodes`
+and `decodes` methods directly:
+
+``` python
+import statistics
+
+class NormalizeMean(Transform):
+    def setups(self, items): 
+        self.mean = statistics.mean(items)
+        self.std  = statistics.stdev(items)
+    
+    def encodes(self, x): 
+        return (x - self.mean) / self.std
+    
+    def decodes(self, x): 
+        return x * self.std + self.mean
+
+normalize = NormalizeMean()
+normalize.setup([1, 2, 3, 4, 5])
+normalize.mean
+```
+
+    3
+
+### Type-based multiple dispatch
+
+Instead of providing one raw functions, you can provide multiple raw
+functions which differ in their parameter types. Tranform will use
+type-based dispatch to automatically execute the correct function.
+
+This is handy when your inputs come in different types (eg., different
+image formats, different numerical types).
+
+``` python
+def inc1(x:int): return x+1
+def inc2(x:str): return x+"a"
+
+t = Transform(enc=(inc1,inc2))
+
+t(5), t('b')
+```
+
+    (6, 'ba')
+
+If an input type does not match any of the type annotations then the
+original input is returned.
+
+``` python
+add_one(2.0)
+```
+
+    3.0
+
+``` python
+normalize(3.0)
+```
+
+    0.0
+
+### Type conversion/preservation
+
+You initialize a Transform by passing in or decorating a raw function.
+
+A Transform `encodes` or `decodes` will note the return type of its raw
+function, which may be defined explicitly or implicitly, and enhance
+type-handling behavior in three ways:
+
+1.  **Guaranteed return type**. It will always return the return type of
+    the raw function, promoting values if necessary.
+
+2.  **Type Preservation**. It will return the runtime type of its
+    argument, whenever that is a subtype of the return type.
+
+3.  **Opt-out conversion**. If you explicitly mark the raw function’s
+    return type as `None`, then it will not perform any type conversion
+    or preservation.
+
+Examples help make this clear:
+
+#### Guaranteed return type
+
+Say you define `FS`, a subclass of `float`. The usual Python type
+promotion behavior means that an `FS` times a `float` is still a
+`float`:
+
+``` python
+class FS(float):
+  def __repr__(self): return f'FS({float(self)})'
+ 
+f1 = float(1)
+FS2 = FS(2)
+
+val = f1 * FS2
+type(val) # => float
+```
+
+    float
+
+With Transform, you can define a new multiplication operation which will
+be guaranteed to return a `FS`, because Transform reads the required raw
+function’s annotated return type:
+
+``` python
+def double_FS(x)->FS: return FS(2)*x
+t = Transform(double_FS)
+val = t(1) 
+assert isinstance(val,FS)
+val
+```
+
+    FS(2.0)
+
+#### Type preservation
+
+Let us say that we define a transform *without* any return type
+annotation, so that the raw function is defined only by the behavior of
+multiplying its argument by the float 2.0.
+
+Multiplying the subtype `FS` with the float value 2 would normally
+return a `float`. However, Transform’s `encodes` will *preserve the
+runtime type of its argument*, so that it returns `FS`:
+
+``` python
+def double(x): return x*2.0  # no type annotation
+t = Transform(double)
+fs1 = FS(1)
+val = t(fs1)
+assert isinstance(val,FS)
+val # => FS(2), an FS value of 2
+```
+
+    FS(2.0)
+
+#### Opt-out conversion
+
+Sometimes you don’t want Transform to do any type-based logic. You can
+opt-out of this system by declaring that your raw function’s return type
+is `None`:
+
+``` python
+def double_none(x) -> None: return x*2.0  # "None" returnt type means "no conversion"
+t = Transform(double_none)
+fs1 = FS(1)
+val = t(fs1)
+assert isinstance(val,float)
+val # => 2.0, a float of 2, because of fallback to standard Python type logic
+```
+
+    2.0
+
+### Pipelines
+
+Transforms can be combined into larger **Pipelines**:
+
+``` python
+def double(x): return x*2.0 
+def halve(x): return x/2.0
+dt = Transform(double,halve)
+
+class NormalizeMean(Transform):
+    def setups(self, items): 
+        self.mean = statistics.mean(items)
+        self.std  = statistics.stdev(items)
+    
+    def encodes(self, x):
+        return (x - self.mean) / self.std
+    
+    def decodes(self, x):
+        return x * self.std + self.mean
+
+
+p = Pipeline((dt, normalize))
+
+v = p(5)
+v
+```
+
+    4.427188724235731
+
+``` python
+p.decode(v)
+```
+
+    5.0
+
+### Documentation
+
+This was just a quickstart. Learn more by reading the
+[documentation](https://github.io/AnswerDotAI/fasttransform).