jmschrei / bpnet-lite

This repository hosts a minimal version of a Python API for BPNet.
MIT License
31 stars 14 forks source link

Mislabeling of functions from bpnetlite.io in the example code for Python API #9

Open Renee-Napoliello opened 4 months ago

Renee-Napoliello commented 4 months ago

The below line of example code in the README.md lists

import torch

from bpnetlite.io import extract_loci
from bpnetlite.io import LocusGenerator
from bpnetlite import BPNet

However in bpnetlite.io there is no LocusGenerator function. There is only DataGenerator or PeakGenerator. In addition, there is no extract_loci function in bpnetlite.io (but it does call one from tangermeme.io)

Should the code be instead like below?

import torch

from tangermeme.io import extract_loci
from bpnetlite.io import PeakGenerator
from bpnetlite import BPNet
jmschrei commented 4 months ago

That's weird -- I thought I had switched over to LocusGenerator. Must've not actually made it in. But, yes, the code should be as you show on the bottom there.