Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Structure of the Python files #13

Closed
marcenacp opened this issue May 9, 2023 · 1 comment · Fixed by #63
Closed

Structure of the Python files #13

marcenacp opened this issue May 9, 2023 · 1 comment · Fixed by #63
Assignees

Comments

@marcenacp
Copy link
Contributor

marcenacp commented May 9, 2023

Use the same structure as JAX for the Python files:

ml_croissant
  |_ __init__.py  # Here main imports for the external API: atm only Dataset
  |_ _src
    |_ dataset.py  # Contains `Dataset`
    |_ record.py  # Contains `Record`
    |_ data_type.py
    |_ issues.py
    |_ operation_graph
      |_ graph.py  # Contains `ComputationGraph`
      |_ operations
        |_ download.py
        |_ read.py
        |_ ...  # Other operations
    |_ structure_graph
      |_ graph.py  # Contains `build_structure_graph`
      |_ nodes
        |_ __init__.py  # Contains the main class `Node`
        |_ metadata.py
        |_ field.py
        |_ file_object.py
        |_ file_set.py

All test files are right next to the file (e.g., issues.py is with issues_test.py).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant