update readme

Author: eugenebokhan

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "rust-lang.rust-analyzer",
+        "vadimcn.vscode-lldb"
+    ]
+}

README.md

@@ -9,23 +9,45 @@ This repository is organized as a Rust workspace with the following crates:
 - **mpsgraph**: Core bindings for MPSGraph API
 - **mpsgraph-tools**: High-level utilities and ergonomic tensor operations API
 
-## Usage
+## Installation
 
-To use the core MPSGraph bindings:
+Add one or both crates to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-mpsgraph = { path = "path/to/mpsgraph-rs/crates/mpsgraph-rs" }
+# Core bindings only
+mpsgraph = "0.1.0"
+
+# Optional: High-level tensor operations
+mpsgraph-tools = "0.1.0"
 ```
 
-To use the high-level tensor operations API:
+For development with the latest version:
 
 ```toml
 [dependencies]
-mpsgraph = { path = "path/to/mpsgraph-rs/crates/mpsgraph-rs" }
-mpsgraph-tools = { path = "path/to/mpsgraph-rs/crates/mpsgraph-tools-rs" }
+# Core bindings from git
+mpsgraph = { git = "https://github.com/eugenebokhan/mpsgraph-rs", package = "mpsgraph" }
+
+# Optional: High-level tensor operations from git
+mpsgraph-tools = { git = "https://github.com/eugenebokhan/mpsgraph-rs", package = "mpsgraph-tools" }
 ```
 
+## Dependencies
+
+- **objc2** (0.6.0): Safe Rust bindings to Objective-C
+- **objc2-foundation** (0.3.0): Rust bindings for Apple's Foundation framework
+- **metal** (0.32.0): Rust bindings for Apple's Metal API
+- **bitflags** (2.9.0): Macro for generating bitflag structures
+- **foreign-types** (0.5): FFI type handling utilities
+- **block** (0.1.6): Support for Objective-C blocks
+
+## Platform requirements:
+
+- macOS 13.0+ (or other Apple platform with Metal support)
+- Metal-supporting GPU
+- Rust 1.85+
+
 ## Examples
 
 ### Core MPSGraph Examples
@@ -79,12 +101,6 @@ cargo test -p mpsgraph
 cargo test -p mpsgraph-tools
 ```
 
-## Requirements
-
-- macOS 13.0 or later
-- Xcode 14.0 or later
-- Metal-supporting GPU
-
 ## License
 
 Licensed under MIT license.

crates/mpsgraph-rs/README.md

@@ -24,6 +24,31 @@ Add this to your `Cargo.toml`:
 mpsgraph = "0.1.0"
 ```
 
+For development with the latest version:
+
+```toml
+[dependencies]
+mpsgraph = { git = "https://github.com/eugenebokhan/mpsgraph-rs", package = "mpsgraph" }
+```
+
+## Dependencies
+
+This crate depends on:
+
+- **objc2** (0.6.0): Safe Rust bindings to Objective-C
+- **objc2-foundation** (0.3.0): Rust bindings for Apple's Foundation framework
+- **metal** (0.32.0): Rust bindings for Apple's Metal API
+- **bitflags** (2.9.0): Macro for generating bitflag structures
+- **foreign-types** (0.5): FFI type handling utilities
+- **block** (0.1.6): Support for Objective-C blocks
+- **rand** (0.9.0): Random number generation utilities
+
+The crate also requires linking against:
+
+- MetalPerformanceShaders.framework
+- Metal.framework
+- Foundation.framework
+
 ## Example
 
 ```rust
@@ -89,116 +114,6 @@ fn main() {
 - Tensor reshaping and transposition
 - Graph compilation for repeated execution
 
-## Advanced Example: Neural Network with MPSGraph
-
-```rust
-use mpsgraph::{Graph, MPSShapeDescriptor, MPSDataType};
-use metal::{Device, MTLResourceOptions};
-use std::collections::HashMap;
-
-fn main() {
-    // Get the system default Metal device
-    let device = Device::system_default().expect("No Metal device found");
-    
-    // Create a graph
-    let graph = Graph::new().expect("Failed to create graph");
-    
-    // Define the neural network architecture
-    // Input: 784 features (28x28 image flattened)
-    // Hidden layer: 128 neurons with ReLU activation
-    // Output: 10 classes with softmax activation
-    
-    // Input placeholder
-    let input_shape = MPSShapeDescriptor::new(vec![1, 784], MPSDataType::Float32);
-    let x = graph.placeholder(&input_shape, Some("input"));
-    
-    // First layer weights and biases
-    let w1_shape = MPSShapeDescriptor::new(vec![784, 128], MPSDataType::Float32);
-    let b1_shape = MPSShapeDescriptor::new(vec![1, 128], MPSDataType::Float32);
-    
-    // Create random weights (would normally be trained or loaded from a file)
-    let mut w1_data = vec![0.0f32; 784 * 128];
-    let mut b1_data = vec![0.0f32; 128];
-    
-    // Initialize with small random values (simplified)
-    for i in 0..w1_data.len() {
-        w1_data[i] = (i as f32 * 0.0001) - 0.05;
-    }
-    
-    let w1 = graph.constant_with_data(&w1_data, &w1_shape, Some("w1"));
-    let b1 = graph.constant_with_data(&b1_data, &b1_shape, Some("b1"));
-    
-    // First layer computation: h1 = ReLU(x · w1 + b1)
-    let xw1 = graph.matmul(&x, &w1, Some("xw1"));
-    let xw1_plus_b1 = graph.add(&xw1, &b1, Some("logits1"));
-    let h1 = graph.relu(&xw1_plus_b1, Some("hidden1"));
-    
-    // Second layer (output layer)
-    let w2_shape = MPSShapeDescriptor::new(vec![128, 10], MPSDataType::Float32);
-    let b2_shape = MPSShapeDescriptor::new(vec![1, 10], MPSDataType::Float32);
-    
-    let mut w2_data = vec![0.0f32; 128 * 10];
-    let mut b2_data = vec![0.0f32; 10];
-    
-    // Initialize with small random values (simplified)
-    for i in 0..w2_data.len() {
-        w2_data[i] = (i as f32 * 0.001) - 0.05;
-    }
-    
-    let w2 = graph.constant_with_data(&w2_data, &w2_shape, Some("w2"));
-    let b2 = graph.constant_with_data(&b2_data, &b2_shape, Some("b2"));
-    
-    // Output layer computation: y = softmax(h1 · w2 + b2)
-    let h1w2 = graph.matmul(&h1, &w2, Some("h1w2"));
-    let logits = graph.add(&h1w2, &b2, Some("logits"));
-    let probs = graph.softmax(&logits, 1, Some("probabilities"));
-    
-    // Create a sample input (a simplified image)
-    let mut input_data = vec![0.0f32; 784];
-    for i in 0..784 {
-        // Create a simple pattern
-        input_data[i] = if (i / 28 + i % 28) % 2 == 0 { 0.9 } else { 0.1 };
-    }
-    
-    // Create input buffer
-    let input_buffer = device.new_buffer_with_data(
-        input_data.as_ptr() as *const _,
-        (784 * std::mem::size_of::<f32>()) as u64,
-        MTLResourceOptions::StorageModeShared
-    );
-    
-    // Create feed dictionary
-    let mut feed_dict = HashMap::new();
-    feed_dict.insert(&x, input_buffer.deref());
-    
-    // Run the graph
-    let results = graph.run(&device, feed_dict, &[&probs]);
-    assert_eq!(results.len(), 1);
-    
-    // Process and print the results (class probabilities)
-    unsafe {
-        let probs_ptr = results[0].contents() as *const f32;
-        let probabilities = std::slice::from_raw_parts(probs_ptr, 10);
-        
-        println!("Class probabilities:");
-        for (i, &prob) in probabilities.iter().enumerate() {
-            println!("  Class {}: {:.6}", i, prob);
-        }
-        
-        // Find the predicted class (highest probability)
-        let mut max_idx = 0;
-        let mut max_prob = probabilities[0];
-        for i in 1..10 {
-            if probabilities[i] > max_prob {
-                max_idx = i;
-                max_prob = probabilities[i];
-            }
-        }
-        
-        println!("Predicted class: {} (probability: {:.6})", max_idx, max_prob);
-    }
-}
-
 ## License
 
 Licensed under the MIT License.

crates/mpsgraph-tools-rs/README.md

@@ -26,17 +26,42 @@ A high-level Rust API for working with Apple's Metal Performance Shaders Graph (
 Add the following to your `Cargo.toml`:
 
 ```toml
-# After the crates are published:
 [dependencies]
+# Core dependencies
 mpsgraph = "0.1.0"
 mpsgraph-tools = "0.1.0"
+```
+
+For development with the latest version:
 
-# For development from git:
+```toml
 [dependencies]
-mpsgraph = { git = "https://github.com/computer-graphics-tools/mpsgraph-rs", package = "mpsgraph" }
-mpsgraph-tools = { git = "https://github.com/computer-graphics-tools/mpsgraph-rs", package = "mpsgraph-tools" }
+mpsgraph = { git = "https://github.com/eugenebokhan/mpsgraph-rs", package = "mpsgraph" }
+mpsgraph-tools = { git = "https://github.com/eugenebokhan/mpsgraph-rs", package = "mpsgraph-tools" }
 ```
 
+## Dependencies
+
+This crate depends on:
+
+- **mpsgraph** (0.1.0): Core MPSGraph bindings
+- **objc2** (0.6.0): Safe Rust bindings to Objective-C
+- **objc2-foundation** (0.3.0): Rust bindings for Apple's Foundation framework
+
+For examples and tests:
+
+- **rand** (0.8.0): Random number generation utilities
+
+The crate also requires linking against MetalPerformanceShadersGraph.framework.
+
+### Supported Platforms
+
+- macOS (Apple Silicon and Intel)
+- iOS
+- tvOS
+- watchOS
+- visionOS
+
 ## Example
 
 ```rust
@@ -142,4 +167,4 @@ fn main() {
 
 ## License
 
-Licensed under the MIT License.
+Licensed under the MIT License.