stan-dev / stan-dev/pystan

No mention of how to generate logs (verbose=True) for pystan3

Open
#380 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
366
Forks
61
PR merge metrics
No merged PRs in 30d

Description

Describe the problem with the documentation

Not sure if this functionality exists yet for pystan3 (ability for user to specify verbosity to generate more extensive logging), but if so it would be grat to document how this argument can be passed into either the build or sampler methods.

Suggest a potential alternative/fix

I have looked in detail at the code base so not sure if this is just a documentation ticket or also a code enhancement.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the pystan3 build and sampler methods to determine whether a verbosity argument such as verbose=True is supported. Check the existing API and documentation for logging guidance, then document the supported usage or clarify the required code enhancement. Done means users can find an accurate way to generate more extensive logs, or the missing functionality is clearly identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.