Skip to content

Commit 8f85c12

Browse files
kMutagenekMutagene
authored
Merge pull request #337 from fslaborg/update-docs
update docs and related tooling
2 parents 4e7f494 + 8054b5c commit 8f85c12

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+830
-14716
lines changed

‎.config/dotnet-tools.json‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22
"version": 1,
33
"isRoot": true,
44
"tools": {
5-
"fsdocs-tool": {
6-
"version": "16.1.1",
7-
"commands": [
8-
"fsdocs"
9-
]
10-
},
115
"fantomas": {
126
"version": "6.1.1",
137
"commands": [
148
"fantomas"
15-
]
9+
],
10+
"rollForward": false
11+
},
12+
"fsdocs-tool": {
13+
"version": "20.0.1",
14+
"commands": [
15+
"fsdocs"
16+
],
17+
"rollForward": false
1618
}
1719
}
1820
}

‎.github/workflows/build-and-test.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ jobs:
1313

1414
steps:
1515
- uses: actions/checkout@v2
16-
- name: Setup .NET
17-
uses: actions/setup-dotnet@v1
16+
- name: Setup .NET 8
17+
uses: actions/setup-dotnet@v4
1818
with:
19-
dotnet-version: '9.x.x'
19+
dotnet-version: '8.x.x'
2020
- name: Restore local tools
2121
run: dotnet tool restore
2222
- name: make script executable
@@ -30,11 +30,11 @@ jobs:
3030
runs-on: windows-latest
3131

3232
steps:
33-
- uses: actions/checkout@v2
34-
- name: Setup .NET
35-
uses: actions/setup-dotnet@v1
33+
- uses: actions/checkout@v4
34+
- name: Setup .NET 8
35+
uses: actions/setup-dotnet@v4
3636
with:
37-
dotnet-version: '9.x.x'
37+
dotnet-version: '8.x.x'
3838
- name: Restore local tools
3939
run: dotnet tool restore
4040
- name: Build and test

‎build/BasicTasks.fs‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,17 @@ let clean = BuildTask.create "Clean" [] {
2828
let build = BuildTask.create "Build" [clean] {
2929
solutionFile
3030
|> DotNet.build (fun p ->
31-
{ p with MSBuildParams = { p.MSBuildParams with DisableInternalBinLog = true }}
31+
let msBuildParams =
32+
{p.MSBuildParams with
33+
Properties = ([
34+
"warnon", "3390"
35+
])
36+
DisableInternalBinLog = true
37+
}
38+
{
39+
p with
40+
MSBuildParams = msBuildParams
41+
}
3242
|> DotNet.Options.withCustomParams (Some "-tl")
3343
)
3444
}

‎build/PackageTasks.fs‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ open TestTasks
88

99
open BlackFox.Fake
1010
open Fake.Core
11+
open Fake.DotNet
1112
open Fake.IO.Globbing.Operators
1213

1314
let pack = BuildTask.create "Pack" [clean; build; runTests] {
@@ -18,17 +19,18 @@ let pack = BuildTask.create "Pack" [clean; build; runTests] {
1819
|> Seq.iter (Fake.DotNet.DotNet.pack (fun p ->
1920
let msBuildParams =
2021
{p.MSBuildParams with
21-
DisableInternalBinLog = true
2222
Properties = ([
2323
"Version",stableVersionTag
2424
"PackageReleaseNotes", (release.Notes |> String.concat "\r\n")
2525
] @ p.MSBuildParams.Properties)
26+
DisableInternalBinLog = true
2627
}
2728
{
2829
p with
2930
MSBuildParams = msBuildParams
3031
OutputPath = Some pkgDir
3132
}
33+
|> DotNet.Options.withCustomParams (Some "--no-dependencies -tl")
3234
))
3335
else failwith "aborted"
3436
}
@@ -41,18 +43,19 @@ let packPrerelease = BuildTask.create "PackPrerelease" [setPrereleaseTag; clean;
4143
|> Seq.iter (Fake.DotNet.DotNet.pack (fun p ->
4244
let msBuildParams =
4345
{p.MSBuildParams with
44-
DisableInternalBinLog = true
4546
Properties = ([
4647
"Version", prereleaseTag
4748
"PackageReleaseNotes", (release.Notes |> String.toLines )
4849
] @ p.MSBuildParams.Properties)
50+
DisableInternalBinLog = true
4951
}
5052
{
5153
p with
5254
VersionSuffix = Some prereleaseSuffix
5355
OutputPath = Some pkgDir
5456
MSBuildParams = msBuildParams
5557
}
58+
|> DotNet.Options.withCustomParams (Some "--no-dependencies -tl")
5659
))
5760
else
5861
failwith "aborted"

‎build/TestTasks.fs‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ open ProjectInfo
77
open BasicTasks
88

99
let runTests = BuildTask.create "RunTests" [clean; build] {
10-
testProject
11-
|> Fake.DotNet.DotNet.test (fun testParams ->
12-
{ testParams with
13-
Logger = Some "console;verbosity=detailed"
14-
Configuration = DotNet.BuildConfiguration.fromString configuration
15-
NoBuild = true
16-
MSBuildParams = { testParams.MSBuildParams with DisableInternalBinLog = true }
10+
Fake.DotNet.DotNet.test(fun testParams ->
11+
{
12+
testParams with
13+
Logger = Some "console;verbosity=detailed"
14+
Configuration = DotNet.BuildConfiguration.fromString configuration
15+
NoBuild = true
16+
MSBuildParams = { testParams.MSBuildParams with DisableInternalBinLog = true }
1717
}
1818
|> DotNet.Options.withCustomParams (Some "-tl")
19-
)
19+
) testProject
2020
}
2121

2222
// to do: use this once we have actual tests
@@ -27,12 +27,12 @@ let runTestsWithCodeCov = BuildTask.create "RunTestsWithCodeCov" [clean; build]
2727
testParams with
2828
MSBuildParams = {
2929
standardParams with
30-
DisableInternalBinLog = true
3130
Properties = [
3231
"AltCover","true"
3332
"AltCoverCobertura","../../codeCov.xml"
3433
"AltCoverForce","true"
3534
]
35+
DisableInternalBinLog = true
3636
};
3737
Logger = Some "console;verbosity=detailed"
3838
}

‎build/build.fsproj‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,4 @@
3131
<PackageReference Include="Fake.Tools.Git" Version="6.1.3" />
3232
</ItemGroup>
3333

34-
<ItemGroup>
35-
<PackageReference Update="FSharp.Core" Version="9.0.202" />
36-
</ItemGroup>
37-
3834
</Project>

‎docs/BasicStats.fsx‎

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,13 @@ categoryindex: 0
1010
(*** hide ***)
1111

1212
(*** condition: prepare ***)
13-
#r "../src/FSharp.Stats/bin/Release/netstandard2.0/FSharp.Stats.dll"
13+
#r "nuget: FSharpAux.Core, 2.0.0"
14+
#r "nuget: FSharpAux, 2.0.0"
15+
#r "nuget: FSharpAux.IO, 2.0.0"
16+
#r "nuget: OptimizedPriorityQueue, 5.1.0"
1417
#r "nuget: FsMath, 0.0.1"
15-
open FsMath
18+
#I "../src/FSharp.Stats/bin/Release/.net8.0/"
19+
#r "FSharp.Stats.dll"
1620
(*** condition: ipynb ***)
1721
#if IPYNB
1822
#r "nuget: FSharp.Stats"
@@ -27,19 +31,6 @@ open FsMath
2731
2832
_Summary:_ this tutorial gives an overview over how to do some of the basic statistical measurements with FSharp.Stats.
2933
30-
### Table of contents
31-
32-
- [Central tendency](#Central-tendency)
33-
- [Mean](#Mean)
34-
- [Truncated mean](#Truncated-mean)
35-
- [Median](#Median)
36-
- [Harmonic mean](#Harmonic-mean)
37-
- [Geometric mean](#Geometric-mean)
38-
- [Dispersion](#Dispersion)
39-
- [Range](#Range)
40-
- [Variance and Standard Deviation](#Variance-and-standard-deviation)
41-
- [Coefficient of variation](#Coefficient-of-variation)
42-
4334
## Central tendency
4435
4536
A [central tendency](https://en.wikipedia.org/wiki/Central_tendency) (or measure of central tendency) is a central or typical value for a probability distribution.

‎docs/Clustering.fsx‎

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,24 @@ categoryindex: 0
1010
(*** hide ***)
1111

1212
(*** condition: prepare ***)
13-
#I "../src/FSharp.Stats/bin/Release/netstandard2.0/"
13+
#r "nuget: FSharpAux.Core, 2.0.0"
14+
#r "nuget: FSharpAux, 2.0.0"
15+
#r "nuget: FSharpAux.IO, 2.0.0"
16+
#r "nuget: OptimizedPriorityQueue, 5.1.0"
17+
#r "nuget: FsMath, 0.0.1"
18+
#I "../src/FSharp.Stats/bin/Release/.net8.0/"
1419
#r "FSharp.Stats.dll"
1520
#r "nuget: Plotly.NET, 4.0.0"
16-
#r "nuget: FSharpAux, 1.0.0"
1721
#r "nuget: Cyjs.NET"
18-
#r "nuget: OptimizedPriorityQueue, 5.1.0"
19-
#r "nuget: FsMath, 0.0.1"
20-
open FsMath
22+
2123

2224
Plotly.NET.Defaults.DefaultDisplayOptions <-
2325
Plotly.NET.DisplayOptions.init (PlotlyJSReference = Plotly.NET.PlotlyJSReference.NoReference)
2426

2527
(*** condition: ipynb ***)
2628
#if IPYNB
27-
#r "nuget: Plotly.NET, 4.0.0"
28-
#r "nuget: Plotly.NET.Interactive, 4.0.0"
29-
#r "nuget: OptimizedPriorityQueue, 5.1.0"
30-
#r "nuget: FSharpAux, 1.0.0"
3129
#r "nuget: FSharp.Stats"
30+
#r "nuget: Plotly.NET, 4.0.0"
3231
#r "nuget: Cyjs.NET"
3332
#endif // IPYNB
3433

@@ -40,22 +39,6 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
4039
4140
_Summary:_ this tutorial demonstrates several clustering methods in FSharp.Stats and how to visualize the results with Plotly.NET.
4241
43-
### Table of contents
44-
45-
- [Iterative Clustering](#Iterative-Clustering)
46-
- [k-means clustering](#k-means-clustering)
47-
- [Density based clustering](#Density-based-clustering)
48-
- [DBSCAN](#DBSCAN)
49-
- [Hierarchical clustering](#Hierarchical-Clustering)
50-
- [Distance measures](#Distance-measures)
51-
- [Linkages](#Linkages)
52-
- [Determining the optimal number of clusters](#Determining-the-optimal-number-of-clusters)
53-
- [Rule of thumb](#Rule-of-thumb)
54-
- [Elbow criterion](#Elbow-criterion)
55-
- [AIC](#AIC)
56-
- [Silhouette coefficient](#Silhouette-coefficient)
57-
- [GapStatistics](#GapStatistics)
58-
5942
Clustering methods can be used to group elements of a huge data set based on their similarity. Elements sharing similar properties cluster together and can be reported as coherent group.
6043
6144
**Column wise standardization**

0 commit comments

Comments
 (0)