Skip to content

Commit

Permalink
Update doc with PatternFolds
Browse files Browse the repository at this point in the history
  • Loading branch information
Azzaare committed Oct 5, 2024
1 parent 047ac25 commit 67f51ee
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 10 deletions.
10 changes: 6 additions & 4 deletions docs/Manifest.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

julia_version = "1.10.5"
manifest_format = "2.0"
project_hash = "c9214e2dba2ff082d61a205904a0de33964d7dfb"
project_hash = "f48021d04a612c69eaeb305defa0e1067166fe92"

[[deps.ANSIColoredPrinters]]
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
Expand Down Expand Up @@ -253,8 +253,8 @@ version = "2.4.2"

[[deps.ConstraintCommons]]
deps = ["Dictionaries", "TestItems"]
git-tree-sha1 = "d02bf23ecd60f1c9bf02b6e88e7aae185ece2d04"
repo-rev = "doc"
git-tree-sha1 = "6328878811c5574a5701eb3645b170572339ac28"
repo-rev = "main"
repo-url = "https://github.com/JuliaConstraints/ConstraintCommons.jl.git"
uuid = "e37357d9-0691-492f-a822-e5ea6a920954"
version = "0.2.3"
Expand Down Expand Up @@ -1054,7 +1054,9 @@ version = "2.8.1"

[[deps.PatternFolds]]
deps = ["Intervals", "Lazy", "Random", "Reexport", "TestItemRunner", "TestItems"]
git-tree-sha1 = "21fb4c221aca131474a886a015a3cd5b1a42b6d2"
git-tree-sha1 = "0698e974b926f0e24019a42fc78fe8498f2f1f04"
repo-rev = "main"
repo-url = "https://github.com/JuliaConstraints/PatternFolds.jl.git"
uuid = "c18a7f1d-76ad-4ce4-950d-5419b888513b"
version = "0.2.5"

Expand Down
1 change: 1 addition & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
LocalSearchSolvers = "2b10edaa-728d-4283-ac71-07e312d6ccf3"
MetaStrategist = "989f9ba8-86ac-4138-b458-047055bae907"
PatternFolds = "c18a7f1d-76ad-4ce4-950d-5419b888513b"
PerfChecker = "6309bf6b-a531-4b08-891e-8ee981e5c424"
QUBOConstraints = "110b7fcc-6942-4061-a625-86e03d1de7cf"
9 changes: 5 additions & 4 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ using PerfChecker

# Constraints
using ConstraintCommons
using PatternFolds
using ConstraintDomains
using Constraints
using ConstraintModels
Expand All @@ -28,8 +29,7 @@ using MetaStrategist
makedocs(;
modules=[
PerfChecker,
ConstraintCommons, ConstraintDomains, Constraints, ConstraintModels,
CompositionalNetworks, QUBOConstraints, ConstraintLearning,
ConstraintCommons, PatternFolds, ConstraintDomains, Constraints, ConstraintModels,
CompositionalNetworks, QUBOConstraints, ConstraintsTranslator, ConstraintLearning,
LocalSearchSolvers, CBLS, #ConstraintExplorer,
MetaStrategist,
Expand Down Expand Up @@ -79,8 +79,9 @@ makedocs(;
"Model Catalog" => "constraints/40_constraint_models.md",
"Internals" => [
"ConstraintCommons.jl" => "constraints/60_constraint_commons.md",
"ConstraintDomains.jl" => "constraints/61_constraint_domains.md",
"Constraints.jl" => "constraints/62_constraints_jl.md",
"PatternFolds.jl" => "constraints/61_pattern_folds.md",
"ConstraintDomains.jl" => "constraints/62_constraint_domains.md",
"Constraints.jl" => "constraints/63_constraints_jl.md",
],
],
"Learning" => [
Expand Down
7 changes: 7 additions & 0 deletions docs/src/constraints/61_pattern_folds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# PatternFolds.jl

Documentation for `PatternFolds.jl`.

```@autodocs
Modules=[PatternFolds]
```
File renamed without changes.
5 changes: 3 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ hero:
actions:
- theme: brand
text: Model, Learn, and Solve!
link: /constraints/intro
link: /constraints/00_intro
- theme: alt
text: View on Github
link: https://github.com/JuliaConstraints/JuliaConstraints.github.io
Expand Down Expand Up @@ -60,7 +60,7 @@ features:
<ul>
<li><a href="https://github.com/JuliaConstraints/Compositionalnetworks.jl"><strong>CompositionalNetworks.jl</strong></a> provides interpretable compositional networks (<em>ICN</em>), a combinatorial variant of neural networks that allows the user to obtain interpretable results, unlike regular artificial neural networks.</li>
<li><a href="https://github.com/JuliaConstraints/QUBOConstraints.jl"><strong>QUBOConstraints.jl</strong></a> is a package that can (automatically) learn QUBO matrices from optimization constraints.</li>
<li><strong>ConstraintsTranslator.jl</strong> (tentative name, WIP) is a tool for converting problems expressed in natural language into optimization models.</li>
<li><a href="https://github.com/JuliaConstraints/ConstraintsTranslator.jl"><strong>ConstraintsTranslator.jl</strong> </a> is a tool for converting problems expressed in natural language into optimization models.</li>
<li><a href="https://github.com/JuliaConstraints/ConstraintLearning.jl"><strong>ConstraintLearning.jl</strong></a> is a common interface that integrates the various components outlined above.</li>
</ul>
<h3>Solvers</h3>
Expand All @@ -71,6 +71,7 @@ features:
<li><a href="https://github.com/JuliaConstraints/CPLEXCP.jl"><strong>CPLEXCP.jl</strong></a> a Julia interface for CPLEX CP Optimizer.</li>
<li><a href="https://github.com/JuliaConstraints/Chuffed.jl"><strong>Chuffed.jl</strong></a> a wrapper for the constraint-programming solver Chuffed to Julia.</li>
<li><a href="https://github.com/JuliaConstraints/JaCoP.jl"><strong>JaCoP.jl</strong></a> a Julia interface for the JaCoP constraint-programming solver.</li>
<li><a href="https://github.com/JuliaConstraints/ConstraintExplorer.jl"><strong>ConstraintExplorer.jl</strong></a> a MOI/JuMP interface to explore search spaces modeled as CP.</li>
</ul>
<h4>JuMP extras</h4>
<p>Constraint Programming is slowly making steps into the main JuMP components. However, some extra resources are available as</p>
Expand Down

0 comments on commit 67f51ee

Please sign in to comment.