Skip to content

Commit 55cdf5a

Browse files
authored
Merge pull request #37 from param087/readme
Added how to get started with swiftML in README.md
2 parents 577894e + cfd8285 commit 55cdf5a

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed

README.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,47 @@
11
# swiftML
2-
Swift library for Machine Learning
2+
3+
Swift library for Machine Learning based on [Swift for TensorFlow](https://github.com/tensorflow/swift) Project.
4+
5+
6+
## Documentation
7+
[https://param087.github.io/swiftML/](https://param087.github.io/swiftML/ )
8+
9+
10+
11+
## Getting Started
12+
13+
* **Install locally**: [Swift for TensorFlow toolchain](https://github.com/tensorflow/swift/blob/master/Installation.md) and Jupyter Kernel for Swift for TensorFlow [swift-jupyter](https://github.com/google/swift-jupyter).
14+
15+
16+
17+
18+
* **Google Colaboratory**: The fastest way to get started is to try out right in your browser. Just open up a [tutorial](https://github.com/param087/swiftML/tree/master/Notebooks), or start from a [blank notebook](https://colab.research.google.com/github/tensorflow/swift/blob/master/notebooks/blank_swift.ipynb)!
19+
20+
21+
### How to include the library in your package
22+
23+
Add the library to your projects dependencies in the Package.swift file as shown below.
24+
```swift
25+
dependencies: [
26+
.package(url: "https://github.com/param087/swiftML", .exact("0.0.2")),
27+
],
28+
```
29+
30+
### How to include the library in your Jupyter Notebook using `%install` directives.
31+
32+
`%install` directives let you install SwiftPM packages so that your notebook
33+
can import them:
34+
35+
```swift
36+
37+
// Install the swiftML package from GitHub.
38+
%install '.package(url: "https://github.com/param087/swiftML", from: "0.0.2")' swiftML
39+
40+
// Install the swiftML package that's in the local directory.
41+
%install '.package(path: "$cwd/swiftML")' swiftML
42+
```
43+
44+
45+
## License
46+
47+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

0 commit comments

Comments
 (0)