Skip to content

Commit

Permalink
SUMMARY:
Browse files Browse the repository at this point in the history
	1. Added initial README.md file
	2. Removed index.html from root
  • Loading branch information
k-arindam committed Oct 8, 2024
1 parent 37f18ec commit 07e2a05
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 1 deletion.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# SwiftNP

SwiftNP is a Swift package for numerical computing inspired by the popular Python library, NumPy. It provides support for multi-dimensional arrays (NDArray), along with basic operations on these arrays, such as reshaping, element-wise operations, and more.

## Features

- Multi-dimensional arrays (`NDArray`)
- Support for various numeric types (e.g., `Int`, `Float`, `Double`, etc.)
- Basic array operations (reshape, element-wise operations, etc.)
- Extensible architecture for additional numerical computing functionality

## Installation

### Swift Package Manager

Add the following to your `Package.swift` file:

```swift
dependencies: [
.package(url: "https://github.com/yourusername/SwiftNP", from: "1.0.0")
]
```

Then, include SwiftNP as a dependency in your target:

```swift
.target(
name: "YourTarget",
dependencies: ["SwiftNP"]),
```

Import SwiftNP

In any Swift file where you want to use SwiftNP:

```swift
import SwiftNP
```

Usage

Creating an NDArray

You can create a multi-dimensional array by specifying the shape and default values:

```swift
let array = SNP.ones(shape: [1, 3, 512, 512])
```

Basic Array Operations

SwiftNP supports element-wise operations, reshaping, and much more:

```swift
let reshapedArray = array.reshape([1, 9])
```

Data Types

SwiftNP supports a wide range of numeric data types. You can specify the data type when creating an NDArray:

```swift
let floatArray = NDArray(shape: [2, 2], dtype: .float64, defaultValue: 21.0)
```

License

This project is licensed under the MIT License. See the LICENSE file for details.
1 change: 0 additions & 1 deletion index.html

This file was deleted.

0 comments on commit 07e2a05

Please sign in to comment.