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

Re-organize API exports #63

Closed
markmc opened this issue Jul 2, 2024 · 1 comment · Fixed by #73
Closed

Re-organize API exports #63

markmc opened this issue Jul 2, 2024 · 1 comment · Fixed by #73
Milestone

Comments

@markmc
Copy link
Contributor

markmc commented Jul 2, 2024

Below is a list of out current API exports and a proposal for how they should be exposed

Top-level package:

Blocks:

  • sdg.filterblock.FilterByValueBlock -> sdg.FilterByValueBlock
  • sdg.importblock.FilterByValueBlock -> sdg.ImportBlock
  • sdg.llmblock.LLMBlock -> sdg.LLMBlock
  • sdg.llmblock.ConditionalLLMBlock -> sdg.ConditionalLLMBlock
  • sdg.utilblocks.SamplePopulatorBlock -> sdg.SamplePopulatorBlock
  • sdg.utilblocks.SelectorBlock -> sdg.SelectorBlock
  • sdg.utilblocks.CombineColumnsBlock -> sdg.CombineColumnsBlock

Default pipelines:

  • sdg.SIMPLE_PIPELINES_PACKAGE and sdg.FULL_PIPELINES_PACKAGE

Exceptions:

  • FilterByValueBlockError
  • EmptyDatasetError
  • PipelineConfigParserError
  • GenerateException
  • TaxonomyReadingException
@russellb
Copy link
Member

russellb commented Jul 2, 2024

related issue: #30

@markmc markmc added this to the 0.1.3 milestone Jul 15, 2024
jwm4 pushed a commit to jwm4/sdg that referenced this issue Dec 13, 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

Successfully merging a pull request may close this issue.

2 participants