segmenteverygrain icon indicating copy to clipboard operation
segmenteverygrain copied to clipboard

absolute vs relative paths

Open jessepisel opened this issue 8 months ago • 4 comments

Running through the notebook examples there are a lot of absolute paths hardcoded to your local machine for images and weights. Can you change those to relative paths so the examples are more self contained?

jessepisel avatar Apr 18 '25 16:04 jessepisel

Naive question: In my own fork, I've put notebooks for different tasks into the root folder. They all reference an "examples" folder containing example images and output for each notebook. Paths are then just './examples/whatever'.

Is that a sensible way to structure it?

(Apologies if this is a distraction; I'm hoping to upstream at least some of my work so I'm hoping it's cool to get some advice here!)

dirtbirb avatar Apr 18 '25 19:04 dirtbirb

I like that structure to help streamline and organize a bit. It would help new users hump in and get the package up and running with the tutorial with minimal changes. Some organization and updating the paths in the notebooks. The Colab notebook would be a bit different, but not a huge issue there.

You should open a pull request with your structure changes and @zsylvester can review. This would definitely help out with the review as well!

jessepisel avatar Apr 21 '25 21:04 jessepisel

My version has a separate notebook for each task (auto segmenting / manual editing / other stuff), relying on a separate module I wrote (#26) to make interactive editing easier. But I don't want to overdo it and push a whole new project right away...

For now I'll do the following, if that would help:

  • Move the original notebooks into the root directory
  • Add an "examples" directory, with subdirectories for the different images used
  • Update input/output paths accordingly (ignoring the co-lab notebook, since that's doing its own thing)

dirtbirb avatar Apr 22 '25 00:04 dirtbirb

Thanks @dirtbirb and @jessepisel - this is great! I have merged the pull request.

I have also added a new example image (in the 'barton_creek' folder), one that has a scale bar in it so that users can see how the pixel-to-units conversion works.

zsylvester avatar Apr 23 '25 23:04 zsylvester