Welcome to TreeValue’s Documentation

Overview

TreeValue is a generalized tree-based data structure. Almost all the operation can be supported in form of trees in a convenient way to simplify the structure processing when the calculation is tree-based.

Tutorials

• Installation
• Quick Start
  • Create a Simplest Tree
  • Create a Slightly Complex Tree
• Main Idea
  • Why TreeValue is designed?
  • Definitions for Key Conceptions
• Basic Usage
  • Create a tree
  • Edit the tree
  • Do index or slice calculation on the tree
  • Do calculation on the tree
  • Make function tree supported
• Advanced Usage
  • Function Modes
  • Inheriting on Trees
  • Process Missing Values
  • Functional Utilities
  • Structural Utilities
  • Tree Utilities
  • Flatten Utilities
  • IO Utilities
  • Object Oriented Usage
  • DIY TreeValue Class
  • More Flexible Ways to DIY Class
  • Draw Graph For TreeValue
• CLI Usage
  • Version Display
  • Help Information Display
  • Exporting Trees to Binary
  • Generate Graph from Trees
• Plugins
  • Potc support

Best Practice

• Apply into Numpy
• Apply into Scikit-Learn

Comparison

• What and Why to Compare
• Run Environment Information
• Comparison Between TreeValue and DM-Tree
  • Mapping Operation
  • Flatten and Unflatten
  • Conclusion
• Comparison Between TreeValue and Tianshou Batch
  • Read and Write Operation
  • Initialization
  • Deep Copy Operation
  • Stack, Concat and Split Operation
• Comparison Between TreeValue and Jax LibTree
  • Mapping Operation
  • Flatten and Unflatten Operation
  • All Operation
  • Reduce Operation
  • Structure Transpose

API Documentation

• treevalue.config
  • treevalue.config.meta
• treevalue.tree
  • treevalue.tree.common
  • treevalue.tree.tree
  • treevalue.tree.func
  • treevalue.tree.general
• treevalue.utils
  • treevalue.utils.color
  • treevalue.utils.formattree
  • treevalue.utils.random
  • treevalue.utils.tree

Contributor Guide

• Architecture
  • Tree
  • TreeValue
  • func_treelize