Advances in documenation and tests.

Author: emmanuellujan

Project.toml

@@ -8,6 +8,8 @@ description = "StreamingSampling is a Julia-based proof-of-concept implementatio
 Determinantal = "2673d5e8-682c-11e9-2dfd-471b09c6c819"
 Distances = "b4f34e82-e78d-54a5-968a-f98e89d6e8f7"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+Ipopt = "b6b21f68-93f8-5de0-b562-5493be1d77c9"
+JuMP = "4076af6c-e467-56ae-b986-b466b2749572"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"

docs/make.jl

@@ -1,23 +1,73 @@
 using StreamingSampling
 using Documenter
+using DocumenterCitations
+using Literate
 
-DocMeta.setdocmeta!(StreamingSampling, :DocTestSetup, :(using StreamingSampling); recursive=true)
-
-makedocs(;
-    modules=[StreamingSampling],
-    authors="Emmanuel Lujan",
-    sitename="StreamingSampling.jl",
-    format=Documenter.HTML(;
-        canonical="https://emmanuellujan.github.io/StreamingSampling.jl",
-        edit_link="main",
-        assets=String[],
-    ),
-    pages=[
-        "Home" => "index.md",
-    ],
+DocMeta.setdocmeta!(
+    StreamingSampling,
+    :DocTestSetup,
+    :(using StreamingSampling);
+    recursive = true,
+)
+
+ENV["BASE_PATH"]    = joinpath(@__DIR__, "../") 
+
+# Citations ####################################################################
+bib = CitationBibliography(joinpath(@__DIR__, "citation.bib"))
+
+
+# Generate examples ############################################################
+const examples_path = joinpath(@__DIR__, "..", "examples")
+const output_path   = joinpath(@__DIR__, "src/generated")
+function create_examples(examples, examples_path, output_path)
+    for (_, example_path) in examples
+        s = split(example_path, "/")
+        sub_path, file_name = string(s[1:end-1]...), s[end]
+        example_filepath = joinpath(examples_path, example_path)
+        Literate.markdown(example_filepath,
+                          joinpath(output_path, sub_path),
+                          documenter = true)
+    end
+    examples = [title => joinpath("generated", replace(example_path, ".jl" => ".md"))
+                for (title, example_path) in examples]
+    return examples
+end
+
+# Basic examples
+examples = [
+    "Simple example" => "simple-example/simple-example.jl",
+]
+basic_examples = create_examples(examples, examples_path, output_path)
+
+# Make and deploy docs #########################################################
+
+makedocs(
+      root    =  joinpath(dirname(pathof(StreamingSampling)), "..", "docs"),
+      source  = "src",
+      build   = "build",
+      clean   = true,
+      doctest = true,
+      modules = [StreamingSampling],
+      repo    = "https://github.com/JuliaLabs/StreamingSampling.jl/blob/{commit}{path}#{line}",
+      highlightsig = true,
+      sitename = "StreamingSampling.jl",
+      expandfirst = [],
+      draft = false,
+      pages = ["Home" => "index.md",
+               "Install and run examples" => "install-and-run-examples.md",
+               "Basic examples" => basic_examples,
+               "API" => "api.md"],
+      format = Documenter.HTML(;
+        prettyurls = get(ENV, "CI", "false") == "true",
+        canonical = "https://github.com/JuliaLabs/StreamingSampling.jl",
+        assets = String[],
+      ),
+      plugins=[bib]
 )
 
 deploydocs(;
-    repo="github.com/emmanuellujan/StreamingSampling.jl",
-    devbranch="main",
+    repo = "https://github.com/JuliaLabs/StreamingSampling.jl",
+    devbranch = "main",
+    push_preview = true,
 )
+

examples/simple-example/Project.toml

@@ -0,0 +1,5 @@
+[deps]
+Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
+StreamingSampling = "e1325ea1-13b9-452d-9115-4dbfefa12b3b"

examples/sme-mvn/gen-data.jl renamed to examples/simple-example/gen-data.jl

@@ -1,4 +1,6 @@
 using StreamingSampling
+using LinearAlgebra
+using Distributions
 
 include("gen-data.jl")
 
@@ -8,5 +10,5 @@ generate_data(file_paths)
 
 # Sampling by StreamMaxEnt
 sme = StreamMaxEnt(file_paths; chunksize=200)
-inds = sample(sme, 100)
+inds = StreamingSampling.sample(sme, 100)
 

examples/sme-mvn/sme-mve.jl renamed to examples/simple-example/simple-example.jl

@@ -11,10 +11,19 @@ using Statistics
                   "data/data2.txt",
                   "data/data3.txt",
                   "data/data4.txt"]
-    println("Checking sample size.")
     sme = StreamMaxEnt(file_paths; chunksize=1000, subchunksize=100)
-    inds = StreamingSampling.sample(sme, 100)
-    @test length(inds) == 100
+    n = 100
+    inds = StreamingSampling.sample(sme, n)
+    ps = StreamingSampling.inclusion_prob(sme, n)
+    
+    println("Checking sample size.")
+    @test round(Int, sum(ps)) ≈ length(inds)
+    
+    println("Checking sum(ps)==n.")
+    @test round(Int, sum(ps)) ≈ n
+    
+    println("Checking 0<=ps_i<=1.")
+    @test all(0 .<= ps .<= 1)
 end
 
 @testset "UPmaxentropy." begin