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

Make it more obvious which names are public #30

Closed
tiran opened this issue Jun 20, 2024 · 2 comments
Closed

Make it more obvious which names are public #30

tiran opened this issue Jun 20, 2024 · 2 comments

Comments

@tiran
Copy link
Contributor

tiran commented Jun 20, 2024

The synthetic data generation code was moved to a separate package instructlab.sdg so it can be consumed by multiple projects. The current project layout does not make it obvious which names are designed for public consumption with a stable API, and which are internal implementation details.

I recommend:

  • prefix all modules with _, e.g. _generate_data.py and _utils.py
  • import public names in __init__.py and include them in __all__ variable.
@russellb
Copy link
Member

Thanks, @tiran.

I expect this code to receive a significant overhaul in the next week or two. I will be sure to ensure these suggestions are incorporated.

FYI @oindrillac @aakankshaduggal @shivchander

@markmc
Copy link
Contributor

markmc commented Jul 30, 2024

I think this is complete as of #73

@markmc markmc closed this as completed Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants