Skip to content

Commit 07cb195

Browse files
authored
Add some descriptions of the repo
1 parent 947680f commit 07cb195

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Readme.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Tensor.NET
22

3+
Tensor.NET is a lightweight and high-performance tensor library which provides numpy-like operations but .NET style interfaces. It supports generic tensor, Linq, C# native slices and so on. It is young so that it may may lack some features or have some BUGs. Please tell us on github or via email, thank you!
4+
35
## Why using Tensor.NET
46

57
Currently, there has been some repositories to support tensor operation, providing numpy-like interfaces, such as [NumSharp](https://github.com/SciSharp/NumSharp) and [TensorFlow.NET](https://github.com/SciSharp/TensorFlow.NET). I also learned a lot from them and thanks for the authors of the two repositories sincerely!
@@ -26,7 +28,7 @@ The following features will be provided in the future.
2628

2729
- Support reading and writing tensor from image, excel, csv and other more formats.
2830

29-
## API map from Numpy to Tensor.NET
31+
## API map from Numpy to Tensor.NET (WIP)
3032

3133
```Tensor.NET``` implements the main features of ```Numpy```. The mapping from Numpy API to Tensor.NET API could be found [here](./doc/API_Mapping.md).
3234

@@ -45,11 +47,11 @@ Currently, most of the docs are in the making. Please wait for some days, thank
4547

4648
For how to build from source, please refer to [this doc](./doc/Build.md)
4749

48-
For how to use, please refer to [the user guide]()
50+
For how to use, please refer to [the user guide]() (WIP)
4951

5052
For examples, please refer to [this repository]()
5153

52-
## Benchmarks
54+
## Benchmarks (WIP)
5355

5456
Benchmarks will be privided later.
5557

@@ -118,10 +120,10 @@ var amax = src.Argmax(0);
118120
var amin = src.Argmin(1);
119121
```
120122

121-
## The main shortcoming
123+
## The major shortcoming
122124

123125
Despite the advantages above, ```Tensor.NET``` does have some shortcomings, the main shortcoming is its basic arithment with operator ```+ - % /```.
124126

125127
Since ```Tensor.NET``` use generic class in its design and operations between tensors of different types are supposed, there's no way to provide these operators in .NET 6 and C# 10 except the operations between tensors of the same data type. For tensors with different data types, ```Add, Sub, Mod, Div``` methods are provided. However, still, there will be some inconvinience.
126128

127-
This problem is supposed to be solved in .NET 7 with its new features. Thanks for the using and waiting!
129+
This problem is supposed to be solved in .NET 7 with its new features. Thanks for the using and waiting!

0 commit comments

Comments
 (0)