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 Update: Expand tutorial to explain run_metrics pipeline #82

Open
cmalinmayor opened this issue Oct 31, 2023 · 0 comments
Open
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@cmalinmayor
Copy link
Collaborator

We want to explain the behind the scenes of run_metrics, showing an example in the tutorial where we instantiate Matcher/Metrics objects and call the API explicitly. This is both educational and potentially useful to users who want to customize their pipelines or examine intermediate objects like matchings. These snippets could also or alternatively be incorporated in the "How It Works" section (currently titled "Getting Started").

@cmalinmayor cmalinmayor added the documentation Improvements or additions to documentation label Oct 31, 2023
@cmalinmayor cmalinmayor added this to the Version 1.0 milestone Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

1 participant