OpenJij/OpenJij

View on GitHub
docs/_toc.yml

Summary

Maintainability
Test Coverage
# Table of contents
# Learn more at https://jupyterbook.org/customize/toc.html

format: jb-book
root:   index
defaults: # The defaults key will be applied to all chapters and sub-sections
  titlesonly: False
options:  # The options key will be applied to all chapters, but not sub-sections
  numbered: False
parts:
  - caption:  API Reference
    title:    OpenJij API レファレンス マニュアル
    numbered: false
    maxdepth: -1
    chapters:
      - file:  reference/openjij/index.rst
      - file:  ref/cxxjij.rst
        sections:
        - file: ref/algorithm.rst
        - file: ref/graph.rst
        - file: ref/result.rst
        - file: ref/system.rst
        - file: ref/utility.rst
  - caption:  日本語 チュートリアル
    title:    OpenJij 日本語 チュートリアル
    numbered: false
    maxdepth: -1
    chapters:
      - file: tutorial/ja/000-intro_optimization_and_Ising
      - file: tutorial/ja/001-openjij_introduction
      - file: tutorial/ja/002-HuboSolver
      - file: tutorial/ja/003-jijmodeling_openjij_tsp
      - file: tutorial/ja/004-Evaluation
      - file: tutorial/ja/005-benchmark_sparse_dense
      - file: tutorial/ja/optimization_index
        sections:
        - file: tutorial/ja/optimization/number_partition
        - file: tutorial/ja/optimization/knapsack
        - file: tutorial/ja/optimization/graph_coloring
        - file: tutorial/ja/optimization/clique_cover
        - file: tutorial/ja/optimization/integer_jobs
        - file: tutorial/ja/optimization/ProteinFoldingHubo
        - file: tutorial/ja/optimization/ReverseQuantumAnnealing
      - file: tutorial/ja/machine_learning_index
        sections:
        - file: tutorial/ja/machine_learning/clustering
        - file: tutorial/ja/machine_learning/qboost
      - file: tutorial/ja/physics_index
        sections:
        - file: tutorial/ja/physics/MonteCarloSampling
        - file: tutorial/ja/physics/IntroductionCoreInterface
        - file: tutorial/ja/physics/ClassicalSystem
        - file: tutorial/ja/physics/QuantumSystem
  - caption:  English Tutorial
    title:    OpenJij English Tutorial
    numbered: false
    maxdepth: -1
    chapters:
      - file: tutorial/en/000-intro_optimization_and_Ising
      - file: tutorial/en/001-openjij_introduction
      - file: tutorial/en/002-HuboSolver
      - file: tutorial/en/003-jijmodeling_openjij_tsp
      - file: tutorial/en/004-Evaluation
      - file: tutorial/en/005-benchmark_sparse_dense
      - file: tutorial/en/006-Machine_Learning_by_QA
      - file: tutorial/en/optimization_index
        sections: 
        - file: tutorial/en/optimization/number_partition
        - file: tutorial/en/optimization/knapsack
        - file: tutorial/en/optimization/graph_coloring
        - file: tutorial/en/optimization/clique_cover
        - file: tutorial/en/optimization/integer_jobs
        - file: tutorial/en/optimization/ProteinFoldingHubo
        - file: tutorial/en/optimization/ReverseQuantumAnnealing
      - file: tutorial/en/machine_learning_index
        sections:
        - file: tutorial/en/machine_learning/clustering
        - file: tutorial/en/machine_learning/qboost
      - file: tutorial/en/physics_index
        sections:
        - file: tutorial/en/physics/MonteCarloSampling
        - file: tutorial/en/physics/IntroductionCoreInterface
        - file: tutorial/en/physics/ClassicalSystem
        - file: tutorial/en/physics/QuantumSystem