algorhino-anemone 0.1.1__py3-none-any.whl

algorhino_anemone-0.1.1.dist-info/METADATA

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: algorhino-anemone
+Version: 0.1.1
+Summary: anemone searches trees
+Author-email: Victor Gabillon <victorgabillon@gmail.com>
+License-Expression: GPL-3.0-only
+Project-URL: Homepage, https://github.com/victorgabillon/anemone
+Project-URL: Bug Tracker, https://github.com/victorgabillon/anemone/issues
+Keywords: tree,search
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: valanga
+Requires-Dist: atomheart
+Requires-Dist: rich
+Requires-Dist: sortedcollections>=2.1.0
+Requires-Dist: graphviz
+Provides-Extra: test
+Requires-Dist: pytest>=8.4.1; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest-cov>=6.0.0; extra == "test"
+Provides-Extra: lint
+Requires-Dist: ruff>=0.14.1; extra == "lint"
+Requires-Dist: pylint>=3.3.8; extra == "lint"
+Provides-Extra: typecheck
+Requires-Dist: mypy>=1.18.2; extra == "typecheck"
+Requires-Dist: pyright[nodejs]>=1.1.408; extra == "typecheck"
+Requires-Dist: types-PyYAML>=6.0.12.12; extra == "typecheck"
+Provides-Extra: dev
+Requires-Dist: tox>=4.32.0; extra == "dev"
+Requires-Dist: black>=25.1.0; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Requires-Dist: sphinx-autodoc-typehints; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Provides-Extra: nn
+Requires-Dist: algorhino-coral; extra == "nn"
+Requires-Dist: torch; extra == "nn"
+Dynamic: license-file
+
+# anemone
+
+`anemone` is a Python library for tree search over `valanga` game states. It builds a
+shared tree graph and layers algorithm-specific wrappers on top so you can plug in
+node evaluation, exploration indices, and selection policies for "tree and value"
+searches.
+
+## Highlights
+
+- Tree-and-value exploration pipeline driven by `TreeAndValueBranchSelector`.
+- Modular factories for node evaluation, selection, index computation, and tree
+  management.
+- Pluggable stopping criteria and recommender rules for final branch selection.
+- Optional torch-based evaluator for batched neural evaluations.
+
+## Installation
+
+```bash
+pip install anemone
+```
+
+Optional torch integration:
+
+```bash
+pip install anemone[nn]
+```
+
+## Quick start
+
+`anemone` exposes factory helpers to build a branch selector configured with your
+node selector, evaluation, and stopping-criterion choices. At runtime you feed it a
+`valanga` state and a seed to get back a branch recommendation.
+
+```python
+from random import Random
+
+from anemone import TreeAndValuePlayerArgs, create_tree_and_value_branch_selector
+from anemone.node_selector.factory import UniformArgs
+from anemone.node_selector.node_selector_types import NodeSelectorType
+from anemone.progress_monitor.progress_monitor import (
+    StoppingCriterionTypes,
+    TreeMoveLimitArgs,
+)
+from anemone.recommender_rule.recommender_rule import SoftmaxRule
+
+# Populate the pieces specific to your game domain.
+args = TreeAndValuePlayerArgs(
+    node_selector=UniformArgs(type=NodeSelectorType.UNIFORM),
+    opening_type=None,
+    stopping_criterion=TreeMoveLimitArgs(
+        type=StoppingCriterionTypes.TREE_MOVE_LIMIT,
+        tree_move_limit=100,
+    ),
+    recommender_rule=SoftmaxRule(type="softmax", temperature=1.0),
+)
+
+selector = create_tree_and_value_branch_selector(
+    state_type=YourStateType,
+    args=args,
+    random_generator=Random(0),
+    master_state_evaluator=your_state_evaluator,
+    state_representation_factory=None,
+    queue_progress_player=None,
+)
+
+recommendation = selector.select_branch(state=current_state, selection_seed=0)
+print(recommendation.branch_key)
+```
+
+## Design
+
+This codebase follows a “core node + wrappers” pattern.
+
+- **`TreeNode` (core)**
+  - `TreeNode` is the canonical, shared data structure.
+  - It stores the graph structure: `branches_children` and `parent_nodes`.
+  - There is conceptually a single tree/graph of `TreeNode`s.
+
+- **Wrappers implement `ITreeNode`**
+  - Higher-level nodes (e.g. `AlgorithmNode`) wrap a `TreeNode` and add algorithm-specific state:
+    evaluation, indices, representations, etc.
+  - Wrappers expose navigation by delegating to the underlying `TreeNode`.
+
+- **Homogeneity at the wrapper level**
+  - Even though `TreeNode` is the core place where connections are stored, each wrapper is intended to be
+    *closed under parent/child links*:
+    - a wrapper’s `branches_children` and `parent_nodes` contain that same wrapper type.
+    - today this is typically either “all `TreeNode`” or “all `AlgorithmNode`”.
+    - in the future, another wrapper can exist (still implementing `ITreeNode`), and it should also be
+      homogeneous within itself.
+
+The practical motivation is:
+- algorithms can be written against `ITreeNode` (for navigation) and against wrappers like `AlgorithmNode`
+  (for algorithm-specific fields),
+- while keeping a single shared underlying structure that can be accessed consistently from any wrapper.
+
+## Repository layout
+
+Each important package folder includes a local README with details. Start with:
+
+- `src/anemone/` for the main search pipeline and public entry points.
+- `src/anemone/node_selector/` for selection strategies (Uniform, RecurZipf, Sequool).
+- `src/anemone/node_evaluation/` for direct evaluation and minmax tree evaluation.
+- `src/anemone/tree_manager/`, `src/anemone/trees/`, and `src/anemone/updates/` for tree construction,
+  expansion, and backpropagation.
+- `src/anemone/indices/` for exploration index computation and updates.
+- `tests/` for index and tree-building fixtures.

algorhino_anemone-0.1.1.dist-info/RECORD

@@ -0,0 +1,82 @@
+algorhino_anemone-0.1.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+anemone/__init__.py,sha256=iKX9OGJxbyIqe9Fy-xxZY6sdH7WcG4RFyPR0WBai7Ls,942
+anemone/basics.py,sha256=jMKY9mFLbbMZ_xNvtBVlbZI_vP15rg2tUGUf9ZQ-9tw,1023
+anemone/factory.py,sha256=xEE5Nx-I9rs-VyhPHQcGTMKSjbVYKYJCO75s5szLZIg,6544
+anemone/state_transition.py,sha256=fxvHZOYRtWV5ExXRIoehdRg9qV6zhgiE5uiCeOc80Dc,1418
+anemone/tree_and_value_branch_selector.py,sha256=AicjYcI1M_zrNZK4ZzYGcHjyCXGATkXGn6vn5bjdJ6s,4099
+anemone/tree_exploration.py,sha256=718qW-mkHp2-LuMfRLHZoi8Oul_3Aq6kzTr31k_xBII,10881
+anemone/indices/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+anemone/indices/index_manager/__init__.py,sha256=P49ofGrnP_Nfmv63Rg_-Zvwn5NFvFFDQ3MD3GMeWNWw,515
+anemone/indices/index_manager/factory.py,sha256=Fti6PTnLOEg0g5cqqRBMsmGGNZw6uVFiKpjv0B766qE,1783
+anemone/indices/index_manager/node_exploration_manager.py,sha256=tcXDgaA7Kne62eOa-RCBTlLx-EYXT-2uTgo0IBNGEbM,21492
+anemone/indices/node_indices/__init__.py,sha256=CHE89gUoI7pPtsnlg5WRUMEiFnFbnLQPy6apu06lVcU,774
+anemone/indices/node_indices/factory.py,sha256=3jQA9Z4RNSD6oX9PlrMppGm7Q0v-CE2zQ2BGjp74Mc0,4045
+anemone/indices/node_indices/index_data.py,sha256=EFa3gktB-EqCtGEPOH-4hDb8t0G6DrFGCJITr-Jlu20,5418
+anemone/indices/node_indices/index_types.py,sha256=L5jaS0piNgwka1ptB6aKjGMIpToNm5Hd2wl0zDoThm8,569
+anemone/nn/torch_evaluator.py,sha256=cXcaldEI5S8JE1Yy9aNUamVEK3DPsPmBmGeUi9611zU,3368
+anemone/node_evaluation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+anemone/node_evaluation/node_direct_evaluation/__init__.py,sha256=2_YwJ3oe0KBfIc3Hs-FLz093RLZsTG-VaNmecLceoiY,898
+anemone/node_evaluation/node_direct_evaluation/factory.py,sha256=lpFmBJkIGAnar5-pQ1vMze9jUFKFchp5Pg2S8eK-ABM,470
+anemone/node_evaluation/node_direct_evaluation/node_direct_evaluator.py,sha256=eHrlyDpwOWpa-7eh8jpWb6-aVoLoDhOLcNJubf40obU,6390
+anemone/node_evaluation/node_tree_evaluation/node_minmax_evaluation.py,sha256=npqy9r7ZKHGMJsDhSY7bZZbRvakwoTyABpwQOVTQ-ww,35126
+anemone/node_evaluation/node_tree_evaluation/node_tree_evaluation.py,sha256=-fiuTO0nWKKiKWAdgFi-L8kKxIjH0A_0yeUKrp4fk34,4260
+anemone/node_evaluation/node_tree_evaluation/node_tree_evaluation_factory.py,sha256=UY1glqflqMOqOPAHhtuzJ8QhGOp55Y9InqdhCMt9KJ8,1279
+anemone/node_factory/__init__.py,sha256=1ijzc7oIpsEMdJQ1jkqfaonhyvPjeyKv0nDe8tCXRAQ,549
+anemone/node_factory/algorithm_node_factory.py,sha256=COu6MiSyW-9M6pDZhJFAuWbp1E-HH9etm90VCoR5r0E,3919
+anemone/node_factory/base.py,sha256=2utUE5s-KbMtzfyiW3BfzTBnH_Qg4H5Oeosw0ERYJRQ,2132
+anemone/node_selector/__init__.py,sha256=DThR5UV-4WZG4PT5Lo0RPv9_P83ixFGfOSFoGihKtuA,1320
+anemone/node_selector/branch_explorer.py,sha256=3ywYkJe2R1Dg5nhmDXCgyhex85bT39Ql7ifRY--9Z_A,2677
+anemone/node_selector/factory.py,sha256=XfTU7M-XiUsxPV3NpGjeiat7Px7Atzk5EMj8D3iV48k,1829
+anemone/node_selector/node_selector.py,sha256=olAyA1_at7VkepZ0hI5S-zfmJAJOVk32XnMKnvHMX7w,1182
+anemone/node_selector/node_selector_args.py,sha256=G0mDPXEOF6oYXqt1176srKrRwDoy31wN8gu9Hzy_8ic,555
+anemone/node_selector/node_selector_types.py,sha256=827M2u8D_yBSdufvV3ufjGtj8r1aw4Xcdb7NXYq_T7M,329
+anemone/node_selector/notations_and_statics.py,sha256=leB0s6yVGeymMWcbbdO5ViDInChLAgGw59-9Ltc3Urw,2653
+anemone/node_selector/opening_instructions.py,sha256=B3ayjIgBjiT-8ZAQVQyYIJH66SBm1DElQoJtwY5h6Xc,8187
+anemone/node_selector/recurzipf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+anemone/node_selector/recurzipf/recur_zipf_base.py,sha256=hdOHAnYQVSlhvuQSGaqHd79j5X8qeJrnzVU_yo8OBCo,5193
+anemone/node_selector/sequool/__init__.py,sha256=k_YXvShw64GNIAWjZqdNPkUsdCMwPI_RSAmv4I2xxuk,485
+anemone/node_selector/sequool/factory.py,sha256=jZqgUs9AR1iU1RI4Jc2OiqYsr_kGnnTabk4WterrtNU,3416
+anemone/node_selector/sequool/sequool.py,sha256=qLwGDTlgC8SgD5BrUvQTpQ5nkfxwop5ceKDcDoiOLPo,12649
+anemone/node_selector/uniform/__init__.py,sha256=fRGC0FL_fnXXeNoj3QeMQmNoESrFfSDaiHp-zHpF_zw,366
+anemone/node_selector/uniform/uniform.py,sha256=9nGsG8NRgAKwYH-VBywUEAO6lDsgPRX84HkFzyB49TU,3710
+anemone/nodes/__init__.py,sha256=yciGi5-PTnXXyuAtf2WfOAkK3_FsFxskfGLjqzHF0zc,384
+anemone/nodes/itree_node.py,sha256=tMmH6fQtXH01DRluyOpRM44n4_1-sndWBKMFsUf-Zt8,3564
+anemone/nodes/tree_node.py,sha256=_n1dHgII40gtRBYiHvB5UDgQykSSsfLGSdb5IX-67Yc,8333
+anemone/nodes/tree_traversal.py,sha256=du_NuWpRX2Qi-9w2WTeos4lEHHj-lrN3yUbdp9tEA2U,3955
+anemone/nodes/utils.py,sha256=KvXQcUcTWx8GvWmhykimgt9m-8WTKoALrnG-3WgNx80,5067
+anemone/nodes/algorithm_node/__init__.py,sha256=8cNk3PmDzd22K78YWiO29Mu5A1FCObzPwEfWE1ym6Jk,116
+anemone/nodes/algorithm_node/algorithm_node.py,sha256=VgUzzouLWO4Pcx3yglAzngF6sJ5VAf3PyZmsm8-tqRU,6501
+anemone/progress_monitor/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+anemone/progress_monitor/progress_monitor.py,sha256=oK0gckMoFqQaOrOwybtW58tcBQz7PqkKV0Lu1V-gXpw,10821
+anemone/recommender_rule/__init__.py,sha256=9K73T0bkpvHg0IsQc1OW8QgsUhCNYq9ceqPMkwdqE8c,347
+anemone/recommender_rule/recommender_rule.py,sha256=w6Y83j_LlnBx0iz25_OGFRZ1VnjlUXKZjlQfIjCRu5s,4594
+anemone/search_factory/__init__.py,sha256=ToU88Fa1lBBdf2AYTJ2PNVwWzi5Hzh-78-WOxClVkN4,619
+anemone/search_factory/search_factory.py,sha256=vCkxJk4cs6i6jjrTrUAsRBtp38N84j_uhyvpYIODoG4,6757
+anemone/tree_manager/__init__.py,sha256=D3j8emzRNF1fkPTpNUPsXbqAzMM9SyI3Ty_4Y_b2Tas,962
+anemone/tree_manager/algorithm_node_tree_manager.py,sha256=s4Iojk9u1fsNso_wH5xMYxHmGIFneLmQN9As2bfViT4,8811
+anemone/tree_manager/factory.py,sha256=d10uuf5DtHZ_jKT7Z688Wd3_a7TewwmUywlTeWdUQwc,2679
+anemone/tree_manager/tree_expander.py,sha256=qq_8EvRaVpgzqI4W3jvI8VJyOnknYgxQuz8yv_pUVkE,4285
+anemone/tree_manager/tree_manager.py,sha256=u-4DsgDxu_7uPUTbWYXYLr9_7NGyPJ25bSYXC2RUc-E,8312
+anemone/trees/__init__.py,sha256=FtX6ZDfZI7JDjv6IAgKRVytJmafL3Vod3RF7L-bDTWc,269
+anemone/trees/descendants.py,sha256=KaEyesB1D5Rxpfl-LrH6pcWM0HV5zkv-2_2GQx_bjX0,27429
+anemone/trees/factory.py,sha256=GIZcojZzxl5VG6lEpxxF9PV8VZnS-c18xWxg0dza0r8,2180
+anemone/trees/tree.py,sha256=90ElKy10ev0YRKwyWo0Ck49WA2iqrVQjM44CQdsm8Sg,2201
+anemone/trees/tree_visualization.py,sha256=gLWoADmuy9MumNR4KLbeWvz3YBU2-bfYO8tvB_ih9FQ,4736
+anemone/updates/__init__.py,sha256=YZsQ8c7RcjC8aHTmty5BiEWfo4_D2GDxZ2_BoyjLJnI,1111
+anemone/updates/algorithm_node_updater.py,sha256=zIoqIRhQNcY5P2JoZ_EM_GB5TrCrWZyrGiMLqEuxStM,5865
+anemone/updates/factory.py,sha256=OuN6cHp9KwSL9bbIEoaJgikp_gX4tU7AjWKasbgttGE,1207
+anemone/updates/index_block.py,sha256=3aVUwcVhwHYm1y2FWGULgMqaw_2FhXDpLue_kbDsLxw,3104
+anemone/updates/index_updater.py,sha256=aFxTtVwLfSwl089_4Sxsce8DDD8NERaUOdj_RqyJUSI,3638
+anemone/updates/minmax_evaluation_updater.py,sha256=sABx1CzXArtxFXwN1Rkq042qKUDVBphpJ6oO3WUh1OQ,4058
+anemone/updates/updates_file.py,sha256=QQRWbYmET2KyWyg_8Qq-WC4jR4FPclWPh7vc01kexdM,10092
+anemone/updates/value_block.py,sha256=TSo7RNmlCxrQpjPIKHNRGU9IfzKE3FA5BCptwwOujAs,4667
+anemone/utils/comparable.py,sha256=eTD81347Qv1dkGR4rD0ep2tbbBR2Mk_4JXZkkYTxiNw,945
+anemone/utils/dataclass.py,sha256=X77ilEUTIVUudfISYlm7rq3tptqUwdLBOzLDy-gL6t8,1781
+anemone/utils/dict_of_numbered_dict_with_pointer_on_max.py,sha256=vVbMWtQavI23zYJ4AuletvSaHrLDfOgvmNPTGolWjVk,4154
+anemone/utils/logger.py,sha256=bJQ8COqdn5obtbi8TuokQHmdHpp57XRksTmfvCLLfyM,2973
+anemone/utils/my_value_sorted_dict.py,sha256=LbqtpBSCS7VrUTUChWCsi18IKZj65FkTJREqbl-xSVA,619
+anemone/utils/small_tools.py,sha256=l9dy5Oqvuvg8qQXqJUfyb3uwBHwVGVrKz6WeTHjyLTk,2766
+algorhino_anemone-0.1.1.dist-info/METADATA,sha256=KTyN1GWK_byEBRVXThAN4PTgewAYl5Knu4HwZrMTap0,5669
+algorhino_anemone-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+algorhino_anemone-0.1.1.dist-info/top_level.txt,sha256=G1vbB-vAevQVde3UZ5X1_Ysy1_6sJDEueHRi2qcDgrY,8
+algorhino_anemone-0.1.1.dist-info/RECORD,,

algorhino_anemone-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+