Skip to content

Commit b858a4e

Browse files
committed
Update docs
1 parent 1415ed2 commit b858a4e

File tree

2 files changed

+27
-78
lines changed

2 files changed

+27
-78
lines changed

LICENSE.md

+8-42
Original file line numberDiff line numberDiff line change
@@ -14,52 +14,18 @@ limitations under the License.
1414

1515
### Origin of this work
1616

17-
This project brings BLAS (Basic Linear Algebra Subprograms) to Scala Native.
18-
The code is written in Scala to interface with the C library interface to BLAS
19-
known as CBLAS. As such this is a derivative work so the applicable licenses
17+
This project brings the TensorFlow to Scala Native.
18+
The code is written in Scala to interface with the C library interface
19+
to TensorFlow. As such this is a derivative work so the applicable licenses
2020
follow to attribute to the original work as best as can be determined.
2121

22-
### License notice for BLAS
22+
### License notice for TensorFlow
2323

24-
The reference BLAS is a freely-available software package. It is available from
25-
netlib via anonymous ftp and the World Wide Web. Thus, it can be included in
26-
commercial software packages (and has been). We only ask that proper credit
27-
be given to the authors.
28-
29-
Like all software, it is copyrighted. It is not trademarked, but we do
30-
ask the following:
31-
32-
- If you modify the source for these routines we ask that you change the
33-
name of the routine and comment the changes made to the original.
34-
35-
- We will gladly answer any questions regarding the software. If a modification
36-
is done, however, it is the responsibility of the person who modified the
37-
routine to provide support.
38-
39-
Please reference the following for information and history about the
40-
project: http://www.netlib.org/blas/
24+
TensorFlow is developed by Google and licensed via the Apache License,
25+
Version 2.0.
4126

4227

4328
### License notice for Documentation
4429

45-
The documentation comes from multiple sources as listed below. There are many
46-
operating systems and vendors that supply BLAS/CBLAS so the list includes ones
47-
that have been referenced for understanding, documentation, and creating tests.
48-
49-
Wikipedia Website:
50-
- https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms
51-
52-
BLAS Website:
53-
- http://www.netlib.org/blas/#_documentation
54-
- http://www.netlib.org/blas/#_blas_routines
55-
56-
Apple Website:
57-
- https://developer.apple.com/documentation/accelerate/blas?language=objc
58-
59-
Intel Website:
60-
- https://software.intel.com/en-us/mkl-developer-reference-c-blas-routines
61-
- https://software.intel.com/en-us/mkl-developer-reference-c-naming-conventions-for-blas-routines
62-
63-
IBM Website:
64-
- https://www.ibm.com/support/knowledgecenter/en/SSFHY8_6.1/reference/am5gr_apa.html
65-
30+
The documentation comes from source files and the TensorFlow
31+
website and should be attributed to the original sources.

README.md

+19-36
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# stensorflow - Scala Native TensorFlow
22
[![Build Status](https://travis-ci.org/ekrich/sblas.svg?branch=master)](https://travis-ci.org/ekrich/stensorflow)
33

4-
This library implements TensorFlow 1.13.1 (Basic Linear Algebra Subprograms) in the form
5-
of CBLAS for the Scala Native platform. Scala Native is a unique platform that
4+
This library implements TensorFlow version `1.13.1` in the form of C TensorFlow
5+
API adapted for the Scala Native platform.
6+
7+
Scala Native is a unique platform that
68
marries the high level language of Scala but compiles to native code with a
79
lightweight managed runtime which includes a state of the art garbage collector.
810
The combination allows for great programming and the ability to use high
9-
performance C language libraries like CBLAS.
11+
performance C language libraries like TensorFlow.
1012

1113
Scala Native uses the Scala compiler to produce
1214
[NIR](https://scala-native.readthedocs.io/en/latest/contrib/nir.html)
@@ -15,12 +17,12 @@ converted to [LLVM IR](http://llvm.org/). Finally LLVM code is optimized
1517
and compiled by [Clang](http://clang.llvm.org/) to produce a native executable.
1618

1719
## Getting started
18-
[![Maven Central](https://img.shields.io/maven-central/v/org.ekrich/sblas_native0.3_2.11.svg)](https://maven-badges.herokuapp.com/maven-central/org.ekrich/sblas_native0.3_2.11)
20+
[![Maven Central](https://img.shields.io/maven-central/v/org.ekrich/stensorflow_native0.3_2.11.svg)](https://maven-badges.herokuapp.com/maven-central/org.ekrich/stensorflow_native0.3_2.11)
1921

2022
If you are already familiar with Scala Native you can jump right in by adding the following dependency in your `sbt` build file.
2123

2224
```scala
23-
libraryDependencies += "org.ekrich" %%% "sblas" % "x.y.z"
25+
libraryDependencies += "org.ekrich" %%% "stensorflow" % "x.y.z"
2426
```
2527

2628
To use in `sbt`, replace `x.y.z` with the version from Maven Central badge above.
@@ -31,13 +33,12 @@ instructions for Scala Native if you are not already setup.
3133

3234
Additional libraries that need to be installed on you system are as follows:
3335

34-
* Linux/Ubuntu can TensorFlow as follows:
36+
* Linux/Ubuntu can TensorFlow following the following directions:
3537

36-
```
37-
$ sudo apt-get install libatlas-base-dev
38-
```
38+
https://www.tensorflow.org/install/lang_c
3939

40-
* macOS can install TensorFlow using [Homebrew](https://formulae.brew.sh/formula/libtensorflow) which will install into the `/usr/local/Cellar/libtensorflow/<version>` directory.
40+
* macOS can install TensorFlow using [Homebrew](https://formulae.brew.sh/formula/libtensorflow)
41+
which will install into the `/usr/local/Cellar/libtensorflow/<version>` directory.
4142

4243
```
4344
$ brew install libtensorflow
@@ -46,43 +47,25 @@ $ brew install libtensorflow
4647
* Other OSes need to have `libtensorflow` available on the system.
4748

4849
## Usage and Help
49-
[![scaladoc](https://www.javadoc.io/badge/org.ekrich/sblas_native0.3_2.11.svg?label=scaladoc)](https://www.javadoc.io/doc/org.ekrich/sblas_native0.3_2.11)
50-
[![Join chat https://gitter.im/ekrich/sblas](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ekrich/sblas?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
50+
[![scaladoc](https://www.javadoc.io/badge/org.ekrich/stensorflow_native0.3_2.11.svg?label=scaladoc)](https://www.javadoc.io/doc/org.ekrich/stensorflow_native0.3_2.11)
51+
[![Join chat https://gitter.im/ekrich/stensorflow](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ekrich/stensorflow?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5152

5253
Reference the link above for Scaladoc. The documentation is a little sparse but hopefully will improve with time.
5354

54-
After `sbt` is installed and any other Scala Native prerequisites are met you can use the following Gitter G8 template instructions to get a fully functional Scala Native application with a couple of BLAS examples in the body of the main program.
55+
After `sbt` is installed and any other Scala Native prerequisites are met you can use the following Gitter G8 template instructions to get a fully functional Scala Native application with an example in the body of the main program.
5556

5657
```
57-
$ sbt new ekrich/sblas.g8
58+
$ sbt new ekrich/stensorflow.g8
5859
$ cd <directory entered after the prompt>
5960
$ sbt run
6061
```
6162

62-
In addition, look at the `v0.1.1` [sblas unit tests](https://github.com/ekrich/sblas/blob/v0.1.1/sblas/src/test/scala/org/ekrich/blas/snic/BlasSuite.scala) for other examples of usage.
63-
64-
## BLAS References and External Documentation
65-
66-
Some useful links are as follows which are also in the LICENSE.md file as some of the Scaladoc was sourced from these references:
67-
68-
Wikipedia Website:
69-
- https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms
70-
71-
Netlib Website:
72-
- http://www.netlib.org/blas/#_documentation
73-
- http://www.netlib.org/blas/#_blas_routines
74-
- http://www.netlib.org/lapack/lapack-3.1.1/html/
75-
76-
Apple Website:
77-
- https://developer.apple.com/documentation/accelerate/blas?language=objc
63+
In addition, look at the `v0.1.0` [stensorflow unit tests](https://github.com/ekrich/stensorflow/blob/v0.1.0/stensorflow/src/test/scala/org/ekrich/stensorflow/snic/TensorflowSuite.scala) for other examples of usage.
7864

79-
Intel Website:
80-
- https://software.intel.com/en-us/mkl-developer-reference-c-blas-routines
81-
- https://software.intel.com/en-us/mkl-developer-reference-c-naming-conventions-for-blas-routines
65+
## TensorFlow References and External Documentation
8266

83-
IBM Website:
84-
- https://www.ibm.com/support/knowledgecenter/en/SSFHY8_6.1/reference/am5gr_apa.html
67+
[TensorFlow Website](https://www.tensorflow.org/)
8568

8669
## Versions
8770

88-
Release [0.1.1](https://github.com/ekrich/sblas/releases/tag/v0.1.1) - (2019-05-01)<br/>
71+
Release [0.1.0](https://github.com/ekrich/tensorflow/releases/tag/v0.1.0) - (2019-XX-XX)<br/>

0 commit comments

Comments
 (0)