Merge pull request #64 from FL03/v0.3.0

V0.3.0
FL03 · Apr 5, 2024 · 5429a4e · 5429a4e
2 parents 325fea1 + 79f722c
commit 5429a4e
Show file tree

Hide file tree

Showing 242 changed files with 11,612 additions and 3,905 deletions.
diff --git a/.artifacts/license/APACHE.LICENSE b/.artifacts/license/APACHE.LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2022 Scattered-Systems
+   Copyright 2024 Scattered-Systems, LLC
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/.artifacts/license/MIT.LICENSE b/.artifacts/license/MIT.LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Scattered-Systems
+Copyright (c) 2024 Scattered-Systems, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -20,6 +20,10 @@ updates:
     directory: /derive
     schedule:
       interval: daily
+  - package-ecosystem: cargo
+    directory: /graphs
+    schedule:
+      interval: daily
   - package-ecosystem: cargo
     directory: /macros
     schedule:

diff --git a/.github/workflows/clippy.yml b/.github/workflows/clippy.yml
@@ -6,45 +6,46 @@ concurrency:
 
 on:
   pull_request:
-    branches-ignore: [ "dev*", "next*" ]
+    branches: [ main ]
   push:
-    branches-ignore: [ "dev*", "next*" ]
-    tags: [ "beta*", "nightly*", "prod*", "v*.*.*"]
+    branches: [ main ]
+    tags: [ nightly*,  v*.*.* ]
   release:
+    types: [ created ]
   repository_dispatch:
-    types: [ "clippy" ]
+    types: [ clippy ]
   schedule:
-    - cron: "30 21 * * *"
+    - cron: 30 21 * * 0 # Every Sunday at 9:30PM UTC
   workflow_dispatch:
 
 permissions:
-  actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+  actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status 
   contents: read
   security-events: write
-  
+
 jobs:
   clippy:
     name: Clippy
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Install Rust toolchain
-        uses: actions-rs/toolchain@16499b5e05bf2e26879000db0c1d13f7e13fa3af #@v1
+      - uses: actions/checkout@v4
+      - name: Setup the toolchain
+        uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: stable
           components: clippy
           override: true
-      - name: Setup (langspace)
+      - name: Installation
         run: cargo install clippy-sarif sarif-fmt
       - name: Analyze
         run:
           cargo clippy
           --all-features
           --message-format=json | clippy-sarif | tee rust-clippy-results.sarif | sarif-fmt
         continue-on-error: true
-      - name: Upload results
-        uses: github/codeql-action/upload-sarif@v2
+      - name: Upload analysis
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: rust-clippy-results.sarif
           wait-for-processing: true
diff --git a/.github/workflows/crates.yml b/.github/workflows/crates.yml
@@ -5,63 +5,44 @@ concurrency:
   cancel-in-progress: false
 
 env:
+  CARGO_PREFIX: ${{ github.event.repository.name }}
   CARGO_TERM_COLOR: always
 
 on:
-  push:
-    tags: [ "nightly*",  "v*.*.*" ]
   release:
-    types: [ "created" ]
+    types: [ created ]
   repository_dispatch:
-    types: [ "publish" ]
+    types: [ publish ]
   workflow_dispatch:
 
 jobs:
-  build:
-    name: build
+  core:
+    name: Publish (core)
     runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: setup (langspace)
-        run: |
-          rustup update
-          rustup default nightly
-      - id: rust-build
-        name: Build
-        run: cargo build -r -v --workspace
-      - uses: actions/cache@v4
-        id: rust-cache
-        name: Cache build
-        with:
-          path: |
-            ~/.cargo/registry
-            ~/.cargo/git
-            target
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
-  sdk:
-    concurrency:
-      group: ${{ github.workflow }}-${{ github.ref }}-sdk
-      cancel-in-progress: false
     env:
-        SDK_NAME: fluidity
+      CARGO_PACKAGE_NAME: ${{ github.event.repository.name }}-core
+    steps:
+      - uses: actions/checkout@v4
+      - name: Publish (${{ env.CARGO_PACKAGE_NAME }})
+        run: cargo publish --all-features -v -p ${{ env.CARGO_PACKAGE_NAME }} --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
+  features:
     name: Publish (sdk)
-    needs: build
+    needs: core
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        features: [ core, derive, macros ]
+        features: [ derive, graphs, macros, tensor ]
+    env:
+      CARGO_PACKAGE_NAME: ${{ github.event.repository.name }}-${{ matrix.features }}
     steps:
-      - uses: actions/checkout@v3
-      - name: Publish (${{ github.ref.name }}-${{ matrix.features }})
-        run: cargo publish --all-features -v -p ${{ github.ref.name }}-${{ matrix.features }} --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
+      - uses: actions/checkout@v4
+      - name: Publish (${{ env.CARGO_PACKAGE_NAME }})
+        run: cargo publish --all-features -v -p ${{ env.CARGO_PACKAGE_NAME }} --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
   publish:
-    concurrency:
-      group: ${{ github.workflow }}-${{ github.ref }}-publish
-      cancel-in-progress: false
-    name: Publish (${{ github.ref.name }})
-    needs: sdk
+    name: Publish (${{ github.repository.name }})
+    needs: features
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Publish (${{ github.ref.name }})
-        run: cargo publish --all-features -v -p ${{ github.ref.name }} --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
+      - uses: actions/checkout@v4
+      - name: Publish (${{ github.event.repository.name }})
+        run: cargo publish --all-features -v -p ${{ github.event.repository.name }} --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -8,68 +8,65 @@ env:
   CARGO_TERM_COLOR: always
 
 on:
-  pull_request:
-    branches-ignore: [ "beta*", "dev*", "next*" ]
   push:
-    branches-ignore: [ "beta*", "dev*", "next*" ]
-    tags: [ "nightly*",  "v*.*.*" ]
+    branches: [ main ]
   release:
+    types: [ created ]
   repository_dispatch:
-    types: [ "publish" ]
+    types: [ rust ]
   schedule:
-    - cron: "30 21 * * *" # 9:30pm UTC
+    - cron: 30 21 * * 0 # Every Sunday at 9:30pm UTC
   workflow_dispatch:
 
 jobs:
-  build:
+  builder:
     name: Build
     strategy:
       matrix:
-        platform: [ ubuntu-latest ]
+        platform: [ macos-latest, ubuntu-latest, windows-latest ]
+        toolchain: [ stable, nightly ]
     runs-on: ${{ matrix.platform }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: setup (langspace)
         run: |
           rustup update
-          rustup default nightly
+          rustup default ${{ matrix.toolchain }}
       - name: Build
-        id: rust-build
-        run: cargo build -F full -r -v --workspace
+        run: cargo build --all-features -r -v --workspace
       - name: Cache build
-        id: rust-cache
+        id: cache-build
         uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/registry
             ~/.cargo/git
             target/release
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          key: ${{ matrix.toolchain }}-${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
   test:
     name: Test
+    needs: [ builder ]
     strategy:
       matrix:
-        platform: [ ubuntu-latest ]
-        toolchain: [ nightly ]
+        toolchain: [ stable, nightly ]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: setup (langspace)
         run: |
           rustup update
           rustup default ${{ matrix.toolchain }}
       - name: Test
-        id: rust-test
-        run: cargo test --all -F full -r -v
+        run: cargo test --all-features -v --workspace
   bench:
-    name: Bench
+    name: Benchmark
+    needs: [ builder ]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: setup (langspace)
         run: |
           rustup update
           rustup default nightly
       - name: Bench
-        id: rust-bench
-        run: cargo bench --all -F full -r -v
+        run: cargo bench --all --features full -v
diff --git a/.gitpod.yml b/.gitpod.yml
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,13 +1,15 @@
 [workspace.package]
 authors = ["FL03 <jo3mccain@icloud.com> (https://github.com/FL03)"]
-categories = []
-description = "Acme is an autodiff library for Rust."
+categories = ["mathematics", "science"]
+description = "Acme aims to provide a solid foundation for developing robust machine-learning systems in Rust."
 edition = "2021"
 homepage = "https://github.com/FL03/acme/wikis"
+keywords = ["acme", "autodiff", "mathematics", "tensor"]
 license = "Apache-2.0"
 repository = "https://github.com/FL03/acme"
 readme = "README.md"
-version = "0.3.0" # TODO - Update cargo package version
+version = "0.3.0"
+# version = "0.3.0-nightly.5"
 
 [workspace]
 default-members = [
@@ -18,15 +20,14 @@ members = [
     "acme", 
     "core",
     "derive",
-    "macros", 
-    "tensor"
+    "graphs",
+    "macros",
+    "tensor",
+    "exp/ndtensor"
 ]
 resolver = "2"
 
 [workspace.dependencies]
-anyhow = "1"
-serde = { features = ["derive"], version = "1" }
-serde_json = "1"
 strum = { features = ["derive"], version = "0.26" }
 smart-default = "0.7"
 

diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2022 Scattered-Systems
+   Copyright 2024 Scattered-Systems, LLC
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 
 ***
 
-Acme is an application toolkit for building cloud-native applications in Rust designed for complete integration with the scsys ecosystem.
+Acme aims to be a complete auto-differentiation library for Rust. The library is designed to be simple to use and easy to integrate into existing projects. The library is still in its early stages and is not yet ready for production use.
 
 ## Getting Started
 

diff --git a/SECURITY.md b/SECURITY.md
@@ -7,7 +7,7 @@ currently being supported with security updates.
 
 | Package      | Current | Supported |
 |--------------|---------|-----------|
-| acme         | 0.2.1   | <=0.2.0   |
+| acme         | 0.3.0   | <=0.3.0   |
 
 ## Reporting a Vulnerability