🔧 chore: release 0.2.0

owkin · Feb 13, 2023 · a410594 · a410594
2 parents 3c09c23 + aa0e3b0
commit a410594
Show file tree

Hide file tree

Showing 185 changed files with 9,799 additions and 2,209 deletions.
diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
@@ -8,7 +8,7 @@ on:
       - release**
 
 jobs:
-  MAExamples:
+  GrAIExamples:
     runs-on: self-hosted
     defaults:
       run:
@@ -19,21 +19,21 @@ jobs:
 
       - name: Setup Conda Environment
         run: |
-          conda create --name maexamples-ci python=3.9
+          conda create --name graiexamples-ci python=3.9
           conda env list
 
       - name: Install Python Library
-        working-directory: Tests/MAExamples/Base
+        working-directory: Tests/GrAIExamples/Base
         run: |
-          conda activate maexamples-ci
+          conda activate graiexamples-ci
           pip="$(dirname `which python`)"/pip
           $pip install -e .
           
       - name: Test
         run: |
-          conda activate maexamples-ci
-          swift test -c release --filter MAExamples
+          conda activate graiexamples-ci
+          swift test -c release --filter GrAIExamples
       
       - name: Remove Conda Environment
         if: always()
-        run: conda env remove --name maexamples-ci
+        run: conda env remove --name graiexamples-ci
diff --git a/.github/workflows/integration-tests.yml b/.github/workflows/integration-tests.yml
@@ -8,7 +8,7 @@ on:
       - release**
 
 jobs:
-  MATorchTests:
+  GrAITorchTests:
     runs-on: self-hosted
     defaults:
       run:
@@ -19,21 +19,21 @@ jobs:
 
       - name: Setup Conda Environment
         run: |
-          conda create --name matorch-ci python=3.9
+          conda create --name graitorch-ci python=3.9
           conda env list
 
       - name: Install Python Library
-        working-directory: Tests/MATorchTests/Base
+        working-directory: Tests/GrAITorchTests/Base
         run: |
-          conda activate matorch-ci
+          conda activate graitorch-ci
           pip="$(dirname `which python`)"/pip
           $pip install -e .
           
       - name: Test
         run: |
-          conda activate matorch-ci
-          swift test --filter MATorchTests
+          conda activate graitorch-ci
+          swift test --filter GrAITorchTests
       
       - name: Remove Conda Environment
         if: always()
-        run: conda env remove --name matorch-ci
+        run: conda env remove --name graitorch-ci
diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
@@ -1,14 +1,19 @@
 name: unit-tests
 
-on: [push]
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - release**
 
 jobs:
-  MAKitTests:
+  GrAITests:
     runs-on: self-hosted
 
     steps:
       - uses: actions/checkout@v3
       - name: Build
         run: swift build
       - name: Test
-        run: swift test -c release --filter MAKitTests
+        run: swift test -c release --filter GrAITests
diff --git a/...ode/xcshareddata/xcschemes/MAKit.xcscheme → ...xcshareddata/xcschemes/GrAIdient.xcscheme b/...ode/xcshareddata/xcschemes/MAKit.xcscheme → ...xcshareddata/xcschemes/GrAIdient.xcscheme
@@ -14,9 +14,9 @@
             buildForAnalyzing = "YES">
             <BuildableReference
                BuildableIdentifier = "primary"
-               BlueprintIdentifier = "MAKit_MAKit"
-               BuildableName = "MAKit_MAKit"
-               BlueprintName = "MAKit_MAKit"
+               BlueprintIdentifier = "GrAIdient"
+               BuildableName = "GrAIdient"
+               BlueprintName = "GrAIdient"
                ReferencedContainer = "container:">
             </BuildableReference>
          </BuildActionEntry>
@@ -28,37 +28,9 @@
             buildForAnalyzing = "YES">
             <BuildableReference
                BuildableIdentifier = "primary"
-               BlueprintIdentifier = "MAKit"
-               BuildableName = "MAKit"
-               BlueprintName = "MAKit"
-               ReferencedContainer = "container:">
-            </BuildableReference>
-         </BuildActionEntry>
-         <BuildActionEntry
-            buildForTesting = "YES"
-            buildForRunning = "YES"
-            buildForProfiling = "NO"
-            buildForArchiving = "NO"
-            buildForAnalyzing = "YES">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "MAKitTests"
-               BuildableName = "MAKitTests"
-               BlueprintName = "MAKitTests"
-               ReferencedContainer = "container:">
-            </BuildableReference>
-         </BuildActionEntry>
-         <BuildActionEntry
-            buildForTesting = "YES"
-            buildForRunning = "YES"
-            buildForProfiling = "YES"
-            buildForArchiving = "YES"
-            buildForAnalyzing = "YES">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "MATestsUtils"
-               BuildableName = "MATestsUtils"
-               BlueprintName = "MATestsUtils"
+               BlueprintIdentifier = "GrAIdient_GrAITorchTests"
+               BuildableName = "GrAIdient_GrAITorchTests"
+               BlueprintName = "GrAIdient_GrAITorchTests"
                ReferencedContainer = "container:">
             </BuildableReference>
          </BuildActionEntry>
@@ -70,9 +42,9 @@
             buildForAnalyzing = "YES">
             <BuildableReference
                BuildableIdentifier = "primary"
-               BlueprintIdentifier = "MAKit_MAExamples"
-               BuildableName = "MAKit_MAExamples"
-               BlueprintName = "MAKit_MAExamples"
+               BlueprintIdentifier = "GrAIdient_GrAIExamples"
+               BuildableName = "GrAIdient_GrAIExamples"
+               BlueprintName = "GrAIdient_GrAIExamples"
                ReferencedContainer = "container:">
             </BuildableReference>
          </BuildActionEntry>
@@ -84,9 +56,9 @@
             buildForAnalyzing = "YES">
             <BuildableReference
                BuildableIdentifier = "primary"
-               BlueprintIdentifier = "MAKit_MATorchTests"
-               BuildableName = "MAKit_MATorchTests"
-               BlueprintName = "MAKit_MATorchTests"
+               BlueprintIdentifier = "GrAITestsUtils"
+               BuildableName = "GrAITestsUtils"
+               BlueprintName = "GrAITestsUtils"
                ReferencedContainer = "container:">
             </BuildableReference>
          </BuildActionEntry>
@@ -102,9 +74,9 @@
       <CodeCoverageTargets>
          <BuildableReference
             BuildableIdentifier = "primary"
-            BlueprintIdentifier = "MAKit"
-            BuildableName = "MAKit"
-            BlueprintName = "MAKit"
+            BlueprintIdentifier = "GrAIdient"
+            BuildableName = "GrAIdient"
+            BlueprintName = "GrAIdient"
             ReferencedContainer = "container:">
          </BuildableReference>
       </CodeCoverageTargets>
@@ -113,29 +85,29 @@
             skipped = "NO">
             <BuildableReference
                BuildableIdentifier = "primary"
-               BlueprintIdentifier = "MAKitTests"
-               BuildableName = "MAKitTests"
-               BlueprintName = "MAKitTests"
+               BlueprintIdentifier = "GrAIExamples"
+               BuildableName = "GrAIExamples"
+               BlueprintName = "GrAIExamples"
                ReferencedContainer = "container:">
             </BuildableReference>
          </TestableReference>
          <TestableReference
             skipped = "NO">
             <BuildableReference
                BuildableIdentifier = "primary"
-               BlueprintIdentifier = "MAExamples"
-               BuildableName = "MAExamples"
-               BlueprintName = "MAExamples"
+               BlueprintIdentifier = "GrAITests"
+               BuildableName = "GrAITests"
+               BlueprintName = "GrAITests"
                ReferencedContainer = "container:">
             </BuildableReference>
          </TestableReference>
          <TestableReference
             skipped = "NO">
             <BuildableReference
                BuildableIdentifier = "primary"
-               BlueprintIdentifier = "MATorchTests"
-               BuildableName = "MATorchTests"
-               BlueprintName = "MATorchTests"
+               BlueprintIdentifier = "GrAITorchTests"
+               BuildableName = "GrAITorchTests"
+               BlueprintName = "GrAITorchTests"
                ReferencedContainer = "container:">
             </BuildableReference>
          </TestableReference>
@@ -158,15 +130,6 @@
       savedToolIdentifier = ""
       useCustomWorkingDirectory = "NO"
       debugDocumentVersioning = "YES">
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "MAKit_MAKit"
-            BuildableName = "MAKit_MAKit"
-            BlueprintName = "MAKit_MAKit"
-            ReferencedContainer = "container:">
-         </BuildableReference>
-      </MacroExpansion>
    </ProfileAction>
    <AnalyzeAction
       buildConfiguration = "Debug">

diff --git a/AUTHORS b/AUTHORS
@@ -1,6 +1,6 @@
 #
 # Below is a list of people and organizations that have contributed
-# to the MAKit project. Names should be added to the list like so:
+# to the GrAIdient project. Names should be added to the list like so:
 #
 # Name/Organization <email address>
 # 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,82 @@
+# 👨‍💻 Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+## 0.2.0 (2022-02-13)
+
+### Features
+
+🪜 **feat:** Softmax1D, DotProduct1D & Constant1D ([#49](https://github.com/owkin/GrAIdient/pull/49))\
+🪜 **feat:** remove activation from layer ([#47](https://github.com/owkin/GrAIdient/pull/47))\
+🪜 **feat:** LayerMerge1D, Sum1D, Concat1D, Concat2D ([#43](https://github.com/owkin/GrAIdient/pull/43))\
+🪜 **layer_2d:** Deconvolution2D ([#42](https://github.com/owkin/GrAIdient/pull/42))\
+🪜 **feat:** getDeltaWeightsGPU per sample API ([#41](https://github.com/owkin/GrAIdient/pull/41))
+
+### Bug Fixes
+
+🐛 **fix:** use buffers for neuron selection in SelectNeurons1D ([#50](https://github.com/owkin/GrAIdient/pull/50))\
+🐛 **fix:** model context max id ([#45](https://github.com/owkin/GrAIdient/pull/45))\
+🐛 **fix:** remove error when data input may indicate lower batch size ([#44](https://github.com/owkin/GrAIdient/pull/44))
+
+### Miscellaneous Tasks
+
+📚 **docs:** PropertyListEncoder by default ([#51](https://github.com/owkin/GrAIdient/pull/51))\
+🎉 **refactor:** logo ([#46](https://github.com/owkin/GrAIdient/pull/46))\
+🎉 **refactor!:** re brand the framework ([#40](https://github.com/owkin/GrAIdient/pull/40))
+
+## 0.1.1 (2022-12-16)
+
+### Features
+
+🪜 **layer_2d:** ResizeBilinearCrop ([#36](https://github.com/owkin/GrAIdient/pull/36))\
+🚀 **perf:** enhance backwardGPU for ResizeBilinear ([#35](https://github.com/owkin/GrAIdient/pull/35))\
+🪜 **layer_2d:** Rotate2D ([#34](https://github.com/owkin/GrAIdient/pull/34))\
+🪜 **layer_2d:** ResizeBilinear ([#32](https://github.com/owkin/GrAIdient/pull/32))\
+🪜 **layer_2d:** Pad2D & Jitter2D ([#30](https://github.com/owkin/GrAIdient/pull/30))\
+🪜 **layer_2d:** add tests for non dirty status ([#27](https://github.com/owkin/GrAIdient/pull/27))\
+🪜 **layer_2d:** FTFrequences2D & Multiply2D ([#25](https://github.com/owkin/GrAIdient/pull/25))\
+🪜 **layer_2d:** LinearScale2D ([#24](https://github.com/owkin/GrAIdient/pull/24))\
+🪜 **layer_2d:** DecorelateRGB ([#23](https://github.com/owkin/GrAIdient/pull/23))\
+🪜 **layer_2d:** RDFT2Image ([#22](https://github.com/owkin/GrAIdient/pull/22))\
+🪜 **core:** Sigmoid activation ([#21](https://github.com/owkin/GrAIdient/pull/21))\
+🚀 **metal:** systematic dispatchThreads API ([#19](https://github.com/owkin/GrAIdient/pull/19))
+
+### Bug Fixes 
+
+🐛 **fix:** update correlation matrix coeffs ([#37](https://github.com/owkin/GrAIdient/pull/37))\
+🐛 **fix:** ResizeBilinear to output deterministic dimensions ([#33](https://github.com/owkin/GrAIdient/pull/33))
+
+### Miscellaneous Tasks
+
+🔨 **refactor:** remove transaction ([#31](https://github.com/owkin/GrAIdient/pull/31))\
+🚨 **integration:** activate DecorrelateRGB in test ([#29](https://github.com/owkin/GrAIdient/pull/29))\
+🚨 **integration:** test IDFT and complex numbers ([#28](https://github.com/owkin/GrAIdient/pull/28))\
+🔨 **tests:** factorize transform tests ([#26](https://github.com/owkin/GrAIdient/pull/26))\
+👷 **ci:** remove swift action ([#20](https://github.com/owkin/GrAIdient/pull/20))\
+👷 **ci:** remove LFS ([#17](https://github.com/owkin/GrAIdient/pull/17))
+
+## 0.1.0 (2022-10-28)
+
+### Features
+
+⚙️ **core:** remove incEpoch & applyGradient rename ([#11](https://github.com/owkin/GrAIdient/pull/11))\
+🚀 **examples:** simple vgg trained on cifar ([#9](https://github.com/owkin/GrAIdient/pull/9))\
+🪜 **layer_2d:** convolution, bn and other 2D layers ([#7](https://github.com/owkin/GrAIdient/pull/7))\
+🪜 **layer_1d:** activation, fl, linear error, mse, select channels ([#5](https://github.com/owkin/GrAIdient/pull/5))\
+⚙️ **core:** Layer architecture ([#4](https://github.com/owkin/GrAIdient/pull/4))\
+⚙️ **core:** Optimizer architecture ([#3](https://github.com/owkin/GrAIdient/pull/3))\
+⚙️ **core:** Model architecture ([#2](https://github.com/owkin/GrAIdient/pull/2))\
+⚡️ **metal:** Metal architecture ([#1](https://github.com/owkin/GrAIdient/pull/1))
+
+### Documentation
+
+📚 update the readme and add documentation ([#12](https://github.com/owkin/GrAIdient/pull/12))
+
+### Miscellaneous Tasks
+
+🔧 **chore:** release 0.1.0 ([#13](https://github.com/owkin/GrAIdient/pull/13))\
+🚀 **test:** reproducibility with PyTorch ([#10](https://github.com/owkin/GrAIdient/pull/10))\
+🪜 **test:** layer2d ([#8](https://github.com/owkin/GrAIdient/pull/8))\
+⚙️ **test:** optimizer, layer1d, clipping ([#6](https://github.com/owkin/GrAIdient/pull/6))
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1,5 +1,5 @@
 #
-# Below is a list of MAKit code owners.
+# Below is a list of GrAIdient code owners.
 # They are responsible for:
 #
 # - reviewing PR before it can be merged into the main branch

diff --git a/Docs/Architecture/ARCHITECTURE.md b/Docs/Architecture/ARCHITECTURE.md
@@ -1,9 +1,9 @@
 # 👷 Architecture
 
-Here are the different components of MAKit: 
+Here are the different components of GrAIdient: 
 
-- [MAKit](MAKit.md)
-- [MATestsUtils](MATestsUtils.md)
-- [MAKitTests](MAKitTests.md)
-- [MATorchTests](MATorchTests.md)
-- [MAExamples](MAExamples.md)
+- [GrAIdient](GrAIdient.md)
+- [GrAITestsUtils](GrAITestsUtils.md)
+- [GrAITests](GrAITests.md)
+- [GrAITorchTests](GrAITorchTests.md)
+- [GrAIExamples](GrAIExamples.md)
diff --git a/Docs/Architecture/GrAIExamples.md b/Docs/Architecture/GrAIExamples.md
@@ -0,0 +1,5 @@
+# 👷 GrAIExamples
+
+`GrAIExamples` contains examples that show how to interact with `GrAIdient`. 
+
+See the [examples](../Examples/EXAMPLES.md) documentation for more details.
diff --git a/Docs/Architecture/MAKitTests.md → Docs/Architecture/GrAITests.md b/Docs/Architecture/MAKitTests.md → Docs/Architecture/GrAITests.md
@@ -1,6 +1,6 @@
-# 👷 MAKitTests
+# 👷 GrAITests
 
-`MAKitTests` contains unit tests of `MAKit`. 
+`GrAITests` contains unit tests of `GrAIdient`. 
 
 Some of them are systematic and repeated over many different setups to ensure 
 that every layer, optimizer, activation function ... is tested.

diff --git a/Docs/Architecture/GrAITestsUtils.md b/Docs/Architecture/GrAITestsUtils.md
@@ -0,0 +1,5 @@
+# 👷 GrAITestsUtils
+
+`GrAITestsUtils` contains utils to enable the testing of plugins of `GrAIdient`.
+
+To know more about plugins, see [this documentation](../Concepts/PLUGIN.md).