diff --git a/docs/make.jl b/docs/make.jl index bf2281e..f148c9e 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -42,32 +42,37 @@ makedocs(; ), pages=[ "Home" => "index.md", - "Getting Started" => "getting_started.md", - "Performance Checking" => [ - "PerfChecker.jl" => "perf_checker.md", - "BenchmarkToolsExt" => "benchmark_ext.md", - "Interface" => "perf_interface.md", + "Constraint Programming" => [ + "Introduction" => "cp/intro.md", + "Optimization(s)?" => "cp/opt.md", ], "Constraints" => [ - "ConstraintCommons.jl" => "constraint_commons.md", - "ConstraintDomains.jl" => "constraint_domains.md", - "Constraints.jl" => "constraints.md", - "ConstraintModels" => "constraint_models.md", + "ConstraintCommons.jl" => "constraints/constraint_commons.md", + "ConstraintDomains.jl" => "constraints/constraint_domains.md", + "Constraints.jl" => "constraints/constraints.md", + "ConstraintModels" => "constraints/constraint_models.md", ], "Learning" => [ - "CompositionalNetworks.jl" => "compositional_networks.md", - "QUBOConstraints.jl" => "qubo_constraints.md", - "ConstraintLearning.jl" => "constraint_learning.md", - ], - "JuMPed Solvers" => [ - "CBLS.jl" => "cbls.md", + "CompositionalNetworks.jl" => "learning/compositional_networks.md", + "QUBOConstraints.jl" => "learning/qubo_constraints.md", + "ConstraintLearning.jl" => "learning/constraint_learning.md", ], - "Raw Solvers" => [ - "LocalSearchSolvers.jl" => "local_search_solvers.md", + "Solvers" => [ + "JuMPed" => [ + "CBLS.jl" => "solvers/cbls.md", + ], + "Others" => [ + "LocalSearchSolvers.jl" => "solvers/local_search_solvers.md", + ], ], "Meta Strategist" => [ - "MetaStrategist.jl" => "meta_strategist.md", - ] + "MetaStrategist.jl" => "meta/meta_strategist.md", + ], + "Performance Checking" => [ + "PerfChecker.jl" => "perf/perf_checker.md", + "BenchmarkToolsExt" => "perf/benchmark_ext.md", + "Interface" => "perf/perf_interface.md", + ], ], warnonly = true, ) diff --git a/docs/src/constraint_commons.md b/docs/src/constraints/constraint_commons.md similarity index 100% rename from docs/src/constraint_commons.md rename to docs/src/constraints/constraint_commons.md diff --git a/docs/src/constraint_domains.md b/docs/src/constraints/constraint_domains.md similarity index 100% rename from docs/src/constraint_domains.md rename to docs/src/constraints/constraint_domains.md diff --git a/docs/src/constraint_models.md b/docs/src/constraints/constraint_models.md similarity index 100% rename from docs/src/constraint_models.md rename to docs/src/constraints/constraint_models.md diff --git a/docs/src/constraints.md b/docs/src/constraints/constraints.md similarity index 100% rename from docs/src/constraints.md rename to docs/src/constraints/constraints.md diff --git a/docs/src/getting_started.md b/docs/src/cp/intro.md similarity index 100% rename from docs/src/getting_started.md rename to docs/src/cp/intro.md diff --git a/docs/src/cp/opt.md b/docs/src/cp/opt.md new file mode 100644 index 0000000..0292f94 --- /dev/null +++ b/docs/src/cp/opt.md @@ -0,0 +1,4 @@ +# The World of Optimization + +Comparison and guidelines about the different way to do optimization. + diff --git a/docs/src/index copy.md b/docs/src/index-old.md similarity index 100% rename from docs/src/index copy.md rename to docs/src/index-old.md diff --git a/docs/src/index.md b/docs/src/index.md index 43358fd..2068021 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -12,15 +12,11 @@ hero: alt: JuliaConstraints actions: - theme: brand - text: Getting Started - link: /getting_started + text: Constraint Programming ?! + link: /constraint_programming - theme: alt text: View on Github - link: https://github.com/JuliaConstraints/JuliaConstraints.github.io - - theme: alt - text: API Examples - link: /cbls - + link: https://github.com/JuliaConstraints/JuliaConstraints.github.io features: - icon: @@ -43,8 +39,27 @@ features:
The Julia Constraints organization is dedicated to advancing Constraint Programming within the Julia ecosystem, serving as a hub for resources that facilitate the creation, understanding, and solution of constraint programming problems. Our goal is to make Constraint Programming accessible and efficient for users at all levels of expertise, by providing a comprehensive suite of tools that integrate seamlessly with JuMP.jl, a popular Julia package for mathematical optimization.
+ +A foundation of common packages (ConstraintCommons, ConstraintDomains, Constraints, ConstraintModels) that supply essential features for constraint programming, ensuring users have the basic tools necessary for their projects.
+ +Advanced packages like CompositionalNetworks, QUBOConstraints, and ConstraintsTranslator bridge the gap between ease of modeling and computational efficiency. These tools learn from constraints and convert natural language problems into constraint programming solutions, requiring minimal input from the user beyond the model itself.
+ +We provide a range of solvers, from native Julia solvers (LocalSearchSolvers) to interfaces with JuMP for external CP solvers, catering to various problem-solving needs.
+ +In its formative stages, MetaStrategist embodies our pioneering spirit. As a burgeoning meta-solving package, it aims to harness the strengths of CP and JuMP. Its vision is to formulate tailored strategies that consider the unique hardware and software resources at hand, offering a new horizon in problem-solving efficiency and adaptability.
+ +PerfChecker.jl transcends its role within Julia Constraints, offering its capabilities to the broader Julia package ecosystem. This indispensable tool for cross-version performance checking not only safeguards the high efficiency and reliability of our packages but also serves the wider community. By facilitating clear and simple performance evaluations, PerfChecker.jl enhances both development and maintenance, contributing to the overall health and progress of Julia's growing library of resources.
-I really wonder! +At Julia Constraints, our mission is to democratize Constraint Programming by providing robust, user-friendly tools that simplify the modeling process, enhance efficiency, and empower users to solve complex problems with ease.
-