Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for library writers #469

Open
1 of 3 tasks
Tracked by #465
hcho3 opened this issue Mar 31, 2023 · 1 comment
Open
1 of 3 tasks
Tracked by #465

Documentation for library writers #469

hcho3 opened this issue Mar 31, 2023 · 1 comment
Labels

Comments

@hcho3
Copy link
Collaborator

hcho3 commented Mar 31, 2023

  • Document Treelite serialization format. #503
  • Write a tutorial for integrating Treelite into a C++ project (using CMake).
  • Write a tutorial for integrating Treelite into a Python package. In particular, library writers should be encouraged to produce treelite.Model object, rather than a custom object with a native Treelite handle.
@hcho3
Copy link
Collaborator Author

hcho3 commented Apr 25, 2023

Currently, Treelite object is a dumb structure, which library writers are expected to fill correctly. It's easy to get it wrong, e.g. by forgetting to fill a field or violating a constraint. See #474 for a recent incident. We need better API design that makes it easy to correctly build tree models. Validation should be built-in.

Credit @RAMitchell

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant