Skip to content

Commit ddb3e12

Browse files
committed
Update docs.
1 parent d7c5a88 commit ddb3e12

File tree

3 files changed

+13
-31
lines changed

3 files changed

+13
-31
lines changed

Tensor/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,10 @@ Release notes are at <http://www.deepml.net/Tensor/articles/ReleaseNotes.html>.
5151

5252
## NuGet packages
5353

54-
NuGet packages can be downloaded from <https://www.myget.org/feed/Packages/coreports>.
54+
The following NuGet packages are available for download.
55+
56+
* [Tensor NuGet package](https://www.nuget.org/packages/Tensor)
57+
* [Tensor.Algorithm NuGet package](https://www.nuget.org/packages/Tensor.Algorithm)
5558

5659
## Documentation
5760

Tensor/Tensor.Docs/articles/Guide-Installation.md

+7-30
Original file line numberDiff line numberDiff line change
@@ -13,32 +13,18 @@ The following system requirements must be met.
1313
* .NET Framework >= 4.7 is supported
1414
* [Mono](https://www.mono-project.com/download/stable/) >= 5.10 is supported, but significantly slower
1515
* For Linux
16-
* The library `libgomp.so.1` must be installed. (install on Ubuntu by running `apt install libgomp1`)
17-
* For MacOS
18-
* [HDF5 libraries](https://support.hdfgroup.org/HDF5/) (install from [Homebrew](https://brew.sh/) by running `brew install hdf5`)
16+
* The library `libgomp.so.1` must be installed. (install on Ubuntu by running `sudo apt install libgomp1`)
1917
* For GPU acceleration (optional)
2018
* nVidia GPU supporting [CUDA compute capability](https://developer.nvidia.com/cuda-gpus) 3.5 or higher
2119
* [nVidia GPU driver](http://www.nvidia.com/Download/index.aspx) 387.92 or higher
2220

2321
## Installation
2422

25-
The library is provided as a NuGet package.
26-
Since we have made modifications (porting to .NET core) to our dependencies and these changes have not yet been merged upstream, a [MyGet](https://myget.org/) feed is currently used to deliever the library and its modified dependencies.
27-
Once all necessary modifications have been merged upstream, the Tensor library will be delivered via standard [NuGet](https://nuget.org).
23+
The library is delivered in two NuGet packages.
24+
The [Tensor NuGet package](https://www.nuget.org/packages/Tensor) provides the [Tensor<'T>](xref:Tensor.Tensor`1) type and all core functions.
25+
Additional algorithms and data exchange methods are provided in the [Tensor.Algorithm NuGet package](https://www.nuget.org/packages/Tensor.Algorithm).
2826

29-
For MacOS you must make sure that the HDF5 libraries are installed on your system.
30-
They can be installed via [Homebrew](https://brew.sh/) by running `brew install hdf5`.
31-
32-
The library is deliverd in two NuGet packages.
33-
The [Tensor NuGet package](https://www.myget.org/feed/coreports/package/nuget/Tensor) provides the [Tensor<'T>](xref:Tensor.Tensor`1) type and all core functions.
34-
Additional algorithms and data exchange methods are provided in the [Tensor.Algorithm NuGet package](https://www.myget.org/feed/coreports/package/nuget/Tensor.Algorithm).
35-
36-
The packages can be installed into your project by performing the following steps.
37-
38-
1. Add the NuGet feed <https://www.myget.org/feed/Packages/coreports> to your project.
39-
This can be done by adding the line ```<add key="CorePorts" value="https://www.myget.org/F/coreports/api/v3/index.json"/>``` to the `packageSources` section of your project `NuGet.config` file.
40-
41-
1. Install the `Tensor` and `Tensor.Algorithm` using the NuGet package manager (either via command line or graphical interface).
27+
The packages can be installed into your project by installing the `Tensor` and `Tensor.Algorithm` packages using the NuGet package manager (either via command line or graphical interface).
4228

4329
## Skeleton project for .NET Core
4430

@@ -51,16 +37,8 @@ $ mkdir tutorial
5137
$ cd tutorial
5238
$ dotnet new console -lang F#
5339
```
54-
Then, create the file `NuGet.config` in the project directory with the following contents.
55-
```xml
56-
<?xml version="1.0" encoding="utf-8"?>
57-
<configuration>
58-
<packageSources>
59-
<add key="CorePorts" value="https://www.myget.org/F/coreports/api/v3/index.json" />
60-
</packageSources>
61-
</configuration>
62-
```
63-
Finally run the following commands to install the Tensor library into your project.
40+
41+
Then, run the following commands to install the Tensor library into your project.
6442
```
6543
$ dotnet add package Tensor
6644
$ dotnet add package Tensor.Algorithm
@@ -96,4 +74,3 @@ You can also directly reference the `Tensor.fsproj` and `Tensor.Algorithm.fsproj
9674
This is useful if you want to modify the Tensor library itself or for debugging.
9775

9876
Please report issues via <https://github.com/DeepMLNet/DeepNet/issues> and submit your pull requests via <https://github.com/DeepMLNet/DeepNet/pulls>.
99-

Tensor/Tensor.Docs/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ This open source library is written in [F#](http://fsharp.org/) and targets the
4646

4747
## News
4848

49+
* **2018/05/07**. Packages are now available on public NuGet. [Tensor NuGet package](https://www.nuget.org/packages/Tensor) and [Tensor.Algorithm NuGet package](https://www.nuget.org/packages/Tensor.Algorithm).
50+
4951
* **2018/05/05**. [The CUDA SDK is no longer required for using GPU acceleration](articles/ReleaseNotes.md).
5052
An up-to-date nVidia GPU driver must be installed, however.
5153

0 commit comments

Comments
 (0)