Merge branch 'dev'

Author: sethjuarez

Build/build.cake

@@ -1,13 +1,14 @@
-#tool "nuget:?package=xunit.runner.console"
-#tool "docfx.msbuild"
 #addin "Newtonsoft.Json"
 #addin "Cake.DocFx"
+#tool "nuget:?package=docfx.console&version=2.16.0"
+#tool "nuget:?package=xunit.runner.console"
+
 
 //////////////////////////////////////////////////////////////////////
 // ARGUMENTS
 //////////////////////////////////////////////////////////////////////
-var release = "0.9.12";
-var suffix = "-beta";
+var release = "0.9.16";
+var suffix = "beta";
 var testFailOk = true;
 var copyright = string.Format("©{0}, Seth Juarez", DateTime.Now.Year);
 var target = Argument("target", "Default");
@@ -48,6 +49,8 @@ public static void UpdateProjectJsonVersion(string version, FilePath projectPath
 //////////////////////////////////////////////////////////////////////
 // TASKS
 //////////////////////////////////////////////////////////////////////
+
+/// CLEAN
 Task("Clean")
     .Does(() =>
 {
@@ -60,43 +63,30 @@ Task("Version")
     .IsDependentOn("Clean")
     .Does(() =>
 {
-    var assemblyInfo = new AssemblyInfoSettings
-    {
-        Product = "numl",
-        Description = "numl is a machine learning library intended to ease the use of using standard modeling techniques for both prediction and clustering",
-        Guid = "554363c6-5979-4c9a-90e6-e70af2d5cc09",
-        Version = release,
-        FileVersion = release,
-        ComVisible = false,
-        Copyright = copyright
-    };
-    // update assembly version
-    Information("Updating AssembyInfo");
-    CreateAssemblyInfo("../Src/numl/Properties/AssemblyInfo.cs", assemblyInfo);
-    // update project.json build
-    Information("Updating numl project.json to " + release+suffix);
-    UpdateProjectJsonVersion(release + suffix, "../Src/numl/project.json", "version");
-    // update test assembly project.json to match new version
-    Information("Updating numl.Tests reference to numl in project.json to " + release+suffix);
-    UpdateProjectJsonVersion(release + suffix, "../Src/numl.Tests/project.json", "dependencies+numl");
+    // update csproj build
+    Information("Updating numl project file");
+    XmlPoke(File("../Src/numl/numl.csproj"), "//PropertyGroup/VersionPrefix", release);
+    XmlPoke(File("../Src/numl/numl.csproj"), "//PropertyGroup/VersionSuffix", suffix);
+    XmlPoke(File("../Src/numl/numl.csproj"), "//PropertyGroup/Copyright", copyright);
 });
 
 Task("Restore")
     .IsDependentOn("Version")
     .Does(() =>
 {
-    DotNetCoreRestore("../Src");
+    DotNetCoreRestore("../src/numl/numl.csproj");
+    DotNetCoreRestore("../src/numl.Tests/numl.Tests.csproj");
 });
 
 Task("Test")
     .IsDependentOn("Restore")
     .Does(() =>
 {
-    DotNetCoreTest("../Src/numl.Tests", new DotNetCoreTestSettings {
+    DotNetCoreTest("../Src/numl.Tests/numl.Tests.csproj", new DotNetCoreTestSettings {
         Configuration = configuration,
-        Framework = "netcoreapp1.0",
+        Framework = "netcoreapp1.1",
         OutputDirectory = buildDir,
-        Verbose = true
+        Verbose = false
     });
 })
 .OnError(exception => 
@@ -115,15 +105,23 @@ Task("Package")
         OutputDirectory = packageDir
     };
 
-    DotNetCorePack("../Src/numl", settings);
+    DotNetCorePack("../Src/numl/numl.csproj", settings);
 });
 
 Task("Docs")
     .IsDependentOn("Package")
     .Does(() => 
 {
     // write out version in prep for doc gen
-    UpdateProjectJsonVersion(release + suffix, "../Docs/version.json", "_appId");
+    if(suffix.Length > 0)
+        UpdateProjectJsonVersion(release + "-" + suffix, "../Docs/version.json", "_appId");
+    else
+        UpdateProjectJsonVersion(release, "../Docs/version.json", "_appId");
+
+    UpdateProjectJsonVersion(DateTime.Now.Year.ToString(), "../Docs/version.json", "_year");
+
+
+    //DocFxMetadata("../Docs/docfx.json");
 
     DocFx("../Docs/docfx.json", new DocFxSettings()
     {

Docs/docfx.json

@@ -4,7 +4,7 @@
       "src": [
         {
           "files": [
-            "project.json"
+            "numl.csproj"
           ],
           "exclude": [
             "**/obj/**",
@@ -67,17 +67,6 @@
         ]
       }
     ],
-    "overwrite": [
-      {
-        "files": [
-          "apidoc/**.md"
-        ],
-        "exclude": [
-          "obj/**",
-          "_site/**"
-        ]
-      }
-    ],
     "dest": "_site",
     "globalMetadataFiles": [ "version.json" ],
     "fileMetadataFiles": [],

Docs/getting-started/descriptors.md

@@ -82,14 +82,6 @@ var d = Descriptor.New()
             .With("PetalWidth").As(typeof(int))
             .Learn("Class").As(typeof(string));
 ```
-
-This style of declaration creates an empty descriptor [New( )] and adds 4 features and 
-a label. The general style of this fluent interface is the use of the With or Learn 
-method (which describes the name of the property that will be accessed) and the 
-As_ method (which describes the property type along with any additional information). 
-The With method adds a Feature to the descriptor while the Learn method overwrites the 
-Label of the descriptor.
-
 This style of declaration creates an empty descriptor [New( )] and adds 4 features and a label. The general style of this fluent interface is the use of the With or Learn method (which describes the name of the property that will be accessed) and the As_ method (which describes the property type along with any additional information). The With method adds a Feature to the descriptor while the Learn method overwrites the Label of the descriptor.
 
 There are sevaral As methods available:
@@ -103,7 +95,7 @@ There are sevaral As methods available:
 
 Utlimately the process of creating descriptors boils down to creating a collection 
 of features as well as an optional label that describes the types that will participate 
-in the learning algorithms. These all impement a conversion between the respective 
+in the learning algorithms. These all implement a conversion between the respective 
 types to a double. Some of these properties when expanded also could potential become 
 multivalued as in the case of Strings, Enumerables, and DateTimes. Here is a list of 
 available properties:

Docs/getting-started/index.md

@@ -14,49 +14,33 @@ There are several links for installing the bits depending on your OS.
 ## Initializing a Project
 
 1. Create a folder for your project
-2. cd into it and `dotnet new` - this will create a basic
+2. cd into it and `dotnet new console` - this will create a basic
    console application
-3. Next we will edit the `project.json` file
-   in order to get `numl` (and its dependencies) referenced
-   in the project. Here is the what the file should look like:
-
-```json
-{
-    "version": "1.0.0-*",
-    "compilationOptions": {
-        "emitEntryPoint": true
-    },
-
-    "dependencies": {
-        "Microsoft.NETCore.Runtime": "1.0.1-beta-*",
-        "System.IO": "4.0.11-beta-*",
-        "System.Console": "4.0.0-*",
-        "System.Runtime": "4.0.21-beta-*",
-        "System.Reflection.TypeExtensions": "4.1.0-*",
-        "System.Linq": "4.0.1-*",
-        "System.Collections.Concurrent": "4.0.11-*",
-        "System.Linq.Expressions": "4.0.11-*",
-        "numl": "0.9.9-*"
-    },
-
-    "frameworks": {
-        "dnxcore50": { }
-    }
-}
-```
-
-These were lines added:
-
-```json
-        "System.Reflection.TypeExtensions": "4.1.0-*",
-        "System.Linq": "4.0.1-*",
-        "System.Collections.Concurrent": "4.0.11-*",
-        "System.Linq.Expressions": "4.0.11-*",
-        "numl": "0.9.9-*"
+3. Next we will add `numl` (and its dependencies) to the project
+   via NuGet. Run `dotnet add package numl -v 0.9.9-*`. This modifies
+   the `.csproj` project file as follows:
+
+```xml
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp1.1</TargetFramework>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="numl" Version="0.9.9-*" />
+  </ItemGroup>
+</Project>```
+
+These were the lines added:
+
+```xml
+  <ItemGroup>
+    <PackageReference Include="numl" Version="0.9.9-*">
+  </ItemGroup>
 ```
 
-If you are using Visual Studio Code, as soon as you make the changes to the
-`project.json` file it will ask you to update the dependencies.
+If you are using Visual Studio Code and edit the project file manually,
+it will ask you to update the dependencies.
 
 # Writing Some Code
 
@@ -89,8 +73,8 @@ namespace ConsoleApplication
 
 # Running the code
 
-1. From the comand line run `dotnet restore`
-2. Once the process is complete run `dotnet run`
+1. Run `dotnet restore` if you've made further changes to the `.csproj` file
+2. Run `dotnet run`
 
 ![numl running](..\images\firstrun.png)
 

Docs/numl/partials/footer.tmpl.partial

@@ -8,7 +8,7 @@
       {{^_appFooter}}
       <div class="row inner-footer">
             <div class="col-md-10">
-                &copy;2016 — <a href="http://sethjuarez.com">Seth Juarez</a><br>
+                &copy;{{_year}} — <a href="http://sethjuarez.com">Seth Juarez</a><br>
                 <a href="https://www.nuget.org/packages/numl/">numl v{{_appId}}</a>
             </div>
             <div class="col-md-2">

Docs/version.json

@@ -1,3 +1,4 @@
 {
-  "_appId": "0.9.12-beta"
+  "_appId": "0.9.16-beta",
+  "_year": "2017"
 }