lincc-frameworks / lincc-frameworks/hyrax

Document expectations for collate and nan behavior

Open
#500 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
41
Forks
7
Avg merge
5d 1h
Merged PRs (30d)
8

Description

*Update*
The assertions in this issue about where collation and nan handling take place are out of date, but the need for documentation remains the same. See the last comment for more details.

*Previous summary*
As part of the overarching refactor, we're asserting that users will not provide externally defined collate functions or nan-handling functions.

Users still have full control over `to_tensor` which should be able to provide a single location to place any additional required logic (that a user might otherwise be tempted to place in collate or nan-handling)

This issue captures the need to document this behavor (i.e. extra collate and nan-handling functionality happens in `to_tensor`) and provide examples of how a user would go about doing this.

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

Read the latest issue comment first, since the update says the earlier assertions about collation and nan handling are outdated. Then locate the documentation and examples for `to_tensor`, collate, and nan handling; done means documenting where users should put additional logic and showing how to do so with examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, machine-learning
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.