JuliaDynamics/ComplexityMeasures.jl

Reproducibility for `OrdinalPatternEncoding`

Open

#379 opened on Jan 13, 2024

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Julia (19 forks)auto 404
discussion-designgood first issue

Repository metrics

Stars
 (79 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, the isless_rand function, which we use as the default value comparator for OrdinalPatternEncoding, will not give reproducible results. This is because we don't provide an rng argument to the rand call.

To solve this, we could either:

  • Force the user to provide their custom lt function, taking care of reproducibility themselves (not preferable IMHO)
  • Include rng as a field to both OrdinalPatternEncoding and OrdinalPatterns, which gets passed on to isless_rand.

Or maybe there's a better way?

Contributor guide

Research direction
Add an rng field to OrdinalPatternEncoding and OrdinalPatterns types, and pass it to isless rand to ensure reproducibility.
Tech stack
julia
Domain
data
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JuliaRandom number generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60