document approach to accuracy

Open Beginner friendly
  • Is something wrong?
#134 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
julia
Domain
documentation

Research direction

Read the recent discussion in issue #45 and compare it with the proposed accuracy guidance in issue #134. Find the package documentation entry point and add a concise description covering the listed accuracy goals, generic fallbacks, method docstrings, and how to request greater accuracy; done when this guidance is documented consistently with the discussion.

Written by the indexing model from the issue text.

Description

Following up on the recent discussion at #45, we should perhaps consider documenting the package's approach to accuracy.

I would say roughly this:

  1. We aim for accurate implementations of at least Float64 inputs. "Accurate" is determined as a practical trade-off.
  2. Most methods have ::Float32 and ::Float16 implementations, with similar aims.
  3. All methods have a generic fallback, which may not be as accurate but should not produce wildly incorrect results.
  4. Docstrings should document more specific claims for each method.
  5. If more accuracy is needed, please open an issue.
Dominant language
Julia
Stars
86
Forks
25
Avg merge
4d 7h
Merged PRs (30d)
3

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from JuliaStats/LogExpFunctions.jl

All issues in JuliaStats/LogExpFunctions.jl

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.