graphnet-team / graphnet

A Deep learning library for neutrino telescopes
https://graphnet-team.github.io/graphnet/
Apache License 2.0
94 stars 94 forks source link

Wrong location for SQLiteDataset in the documentation #746

Closed niklasmei closed 2 months ago

niklasmei commented 2 months ago

Describe the bug In the documentation according to https://graphnet-team.github.io/graphnet/datasets/datasets.html the path to import SQLiteDataset is not up to date. Therefore trying the import as suggested on the site mentioned above does not work.

To Reproduce simply execute the following:

from graphnet.data.sqlite import SQLiteDataset

in the current version of graphnet.

Expected behavior From the documentation I would expect the import to work without error. It works as expected with the correct import:

from graphnet.data.dataset.sqlite.sqlite_dataset import SQLiteDataset

Full traceback

ImportError                               Traceback (most recent call last)
Cell In[9], [line 1](vscode-notebook-cell:?execution_count=9&line=1)
----> [1](vscode-notebook-cell:?execution_count=9&line=1) from graphnet.data.sqlite import SQLiteDataset

ImportError: cannot import name 'SQLiteDataset' from 'graphnet.data.sqlite' (/mnt/c/Users/nikla/Desktop/GraphNet/anaconda_graphnet_file/graphnet/src/graphnet/data/sqlite/__init__.py)

Additional context This is not a problem with graphnet, but just an outdated suggestion in the documentation. You find it specifically in the SQLiteDataset & ParquetDataset subection of the Datasets in GraphNet section of the documentation (https://graphnet-team.github.io/graphnet/datasets/datasets.html)

RasmusOrsoe commented 2 months ago

@niklasmei thanks for reporting this!

The file in question can be edited here: docs/source/datasets/datasets.rst

niklasmei commented 2 months ago

Pull request to fix this issue should also resolve issue #750