sdg-hub 0.5.0__tar.gz → 0.5.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/PKG-INFO +1 -1
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/blocks/transform-blocks.md +2 -2
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/flows/overview.md +348 -1
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/_version.py +3 -3
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/llm/llm_parser_block.py +57 -5
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/llm/text_parser_block.py +57 -5
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/flow/base.py +49 -0
- sdg_hub-0.5.1/src/sdg_hub/core/utils/temp_manager.py +57 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub.egg-info/PKG-INFO +1 -1
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub.egg-info/SOURCES.txt +1 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/actionlint.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/actions/free-disk-space/action.yml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/dependabot.yml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/mergify.yml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/workflows/actionlint.dockerfile +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/workflows/actionlint.yml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/workflows/docs.yml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/workflows/integration-test.yml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/workflows/lint.yml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/workflows/matchers/actionlint.json +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/workflows/matchers/pylint.json +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/workflows/packer.yml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/workflows/pypi.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.github/workflows/test.yml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.gitignore +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.isort.cfg +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.markdownlint-cli2.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.pre-commit-config.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/.pylintrc +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/CLAUDE.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/CONTRIBUTING.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/LICENSE +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/Makefile +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/README.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/.nojekyll +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/README.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/_coverpage.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/_navbar.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/_sidebar.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/api-reference.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/blocks/custom-blocks.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/blocks/filtering-blocks.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/blocks/llm-blocks.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/blocks/overview.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/concepts.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/development.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/flows/discovery.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/index.html +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/installation.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/docs/quick-start.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/annotation/annotation_classification.ipynb +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/annotation/news_classification_assessment_prompt.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/annotation/news_classification_flow.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/annotation/news_classification_prompt.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/annotation/revise_news_classification_prompt.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/enhanced_summary_knowledge_tuning/.env.example +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/enhanced_summary_knowledge_tuning/README.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/enhanced_summary_knowledge_tuning/document_pre_processing.ipynb +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/enhanced_summary_knowledge_tuning/knowledge_generation.ipynb +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/enhanced_summary_knowledge_tuning/knowledge_mixing.ipynb +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/enhanced_summary_knowledge_tuning/knowledge_mixing_utils.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/enhanced_summary_knowledge_tuning/raft_builder.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/.gitignore +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/README.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/assets/imgs/instructlab-banner.png +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/docling_v2_config.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/docparser.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/docparser_v2.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/document_collection/ibm-annual-report/ibm-annual-report-2024.json +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/document_collection/ibm-annual-report/ibm-annual-report-2024.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/document_collection/ibm-annual-report/ibm-annual-report-2024.pdf +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/document_collection/ibm-annual-report/qna.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/document_pre_processing.ipynb +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/knowledge_generation_and_mixing.ipynb +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/instructlab/logger_config.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/knowledge_tuning/knowledge_utils.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/text_analysis/README.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/text_analysis/extract_stock_tickers.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/examples/text_analysis/structured_insights_demo.ipynb +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/pyproject.toml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/scripts/packer/centos.pkr.hcl +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/scripts/packer/setup-centos.sh +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/scripts/ruff.sh +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/setup.cfg +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/base.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/filtering/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/filtering/column_value_filter.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/llm/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/llm/error_handler.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/llm/llm_chat_block.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/llm/llm_chat_with_parsing_retry_block.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/llm/prompt_builder_block.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/registry.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/transform/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/transform/duplicate_columns.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/transform/index_based_mapper.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/transform/json_structure_block.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/transform/melt_columns.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/transform/rename_columns.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/transform/text_concat.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/blocks/transform/uniform_col_val_setter.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/flow/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/flow/checkpointer.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/flow/metadata.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/flow/registry.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/flow/validation.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/utils/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/utils/datautils.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/utils/error_handling.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/utils/flow_id_words.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/utils/flow_identifier.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/utils/flow_metrics.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/utils/logger_config.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/utils/path_resolution.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/utils/time_estimator.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/core/utils/yaml_utils.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/detailed_summary/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/detailed_summary/detailed_summary.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/detailed_summary/flow.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/doc_direct_qa/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/doc_direct_qa/flow.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/extractive_summary/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/extractive_summary/extractive_summary.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/extractive_summary/flow.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/generate_answers.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/generate_multiple_qa.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/generate_question_list.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/key_facts/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/key_facts/flow.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/enhanced_multi_summary_qa/key_facts/key_facts_summary.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/instructlab/README.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/instructlab/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/instructlab/atomic_facts.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/instructlab/detailed_summary.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/instructlab/evaluate_faithfulness.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/instructlab/evaluate_question.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/instructlab/evaluate_relevancy.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/instructlab/extractive_summary.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/instructlab/flow.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/instructlab/generate_questions_responses.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/multilingual/japanese/README.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/multilingual/japanese/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/multilingual/japanese/atomic_facts_ja.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/multilingual/japanese/detailed_summary_ja.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/multilingual/japanese/extractive_summary_ja.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/multilingual/japanese/flow.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/qa_generation/document_grounded_qa/multi_summary_qa/multilingual/japanese/generate_questions_responses_ja.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/text_analysis/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/text_analysis/structured_insights/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/text_analysis/structured_insights/analyze_sentiment.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/text_analysis/structured_insights/extract_entities.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/text_analysis/structured_insights/extract_keywords.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/text_analysis/structured_insights/flow.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/flows/text_analysis/structured_insights/summarize.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub/py.typed +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub.egg-info/dependency_links.txt +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub.egg-info/requires.txt +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/src/sdg_hub.egg-info/top_level.txt +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/filtering/test_columnvaluefilter.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/llm/test_llm_chat_block.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/llm/test_llm_chat_with_parsing_retry_block.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/llm/test_llm_parser_block.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/llm/test_promptbuilderblock.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/llm/test_textparserblock.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/test_base_block.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/test_registry.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/testdata/test_config.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/testdata/test_prompt_format_config.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/testdata/test_prompt_format_no_system.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/testdata/test_prompt_format_strict.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/testdata/test_prompt_invalid_final_role.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/testdata/test_prompt_no_user_messages.yaml +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/transform/test_index_based_mapper.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/transform/test_json_structure_block.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/transform/test_melt_columns.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/transform/test_rename_columns.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/transform/test_text_concat.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/blocks/transform/test_uniform_col_val_setter.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/flow/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/flow/conftest.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/flow/test_base.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/flow/test_checkpointer.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/flow/test_dataset_requirements.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/flow/test_integration.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/flow/test_metadata.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/flow/test_registry.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/flow/test_time_estimation.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/flow/test_validation.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/integration/README.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/integration/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/integration/knowledge_tuning/enhanced_summary_knowledge_tuning/README.md +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/integration/knowledge_tuning/enhanced_summary_knowledge_tuning/__init__.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/integration/knowledge_tuning/enhanced_summary_knowledge_tuning/conftest.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/integration/knowledge_tuning/enhanced_summary_knowledge_tuning/test_data/test_seed_data.jsonl +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/integration/knowledge_tuning/enhanced_summary_knowledge_tuning/test_functional.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/utils/test_datautils.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/utils/test_error_handling.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/utils/test_flow_metrics.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tests/utils/test_path_resolution.py +0 -0
- {sdg_hub-0.5.0 → sdg_hub-0.5.1}/tox.ini +0 -0
|
@@ -19,8 +19,8 @@ Maps values based on their position/index, useful for applying transformations b
|
|
|
19
19
|
### MeltColumnsBlock
|
|
20
20
|
Reshapes data from wide format to long format, converting multiple columns into key-value pairs.
|
|
21
21
|
|
|
22
|
-
###
|
|
23
|
-
|
|
22
|
+
### UniformColumnValueSetter
|
|
23
|
+
Replaces all values in a column with a single statistical aggregate (mode, min, max, mean, or median) computed from the data. Modifies the column in-place, useful for data normalization, creating baseline comparisons, or extracting dominant values.
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
## 🚀 Next Steps
|
|
@@ -116,7 +116,139 @@ metadata:
|
|
|
116
116
|
max_samples: 10000
|
|
117
117
|
```
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
### Metadata Fields Reference
|
|
120
|
+
|
|
121
|
+
The metadata section supports the following fields for flow configuration:
|
|
122
|
+
|
|
123
|
+
#### Core Metadata Fields
|
|
124
|
+
|
|
125
|
+
| Field | Type | Required | Default | Description |
|
|
126
|
+
|-------|------|----------|---------|-------------|
|
|
127
|
+
| `name` | `string` | Yes | - | Human-readable name of the flow. Must be at least 1 character. |
|
|
128
|
+
| `id` | `string` | No | Auto-generated | Unique identifier for the flow. Auto-generated from name if not provided. Must be lowercase, contain only alphanumeric characters and hyphens, and not start/end with hyphens. |
|
|
129
|
+
| `description` | `string` | No | `""` | Detailed description of what the flow does and its purpose. |
|
|
130
|
+
| `version` | `string` | No | `"1.0.0"` | Semantic version following the format `MAJOR.MINOR.PATCH` (e.g., "1.0.0", "2.1.3-beta"). |
|
|
131
|
+
| `author` | `string` | No | `""` | Name of the flow author or contributor. |
|
|
132
|
+
| `license` | `string` | No | `"Apache-2.0"` | License identifier for the flow (e.g., "Apache-2.0", "MIT", "GPL-3.0"). |
|
|
133
|
+
| `tags` | `List[string]` | No | `[]` | List of tags for categorization and discovery. Tags are automatically converted to lowercase. |
|
|
134
|
+
| `recommended_models` | `RecommendedModels` | No | `None` | Recommended LLM models for optimal flow performance. See below for structure. |
|
|
135
|
+
| `dataset_requirements` | `DatasetRequirements` | No | `None` | Input dataset requirements and validation rules. See below for structure. |
|
|
136
|
+
|
|
137
|
+
#### RecommendedModels Structure
|
|
138
|
+
|
|
139
|
+
The `recommended_models` field helps users choose appropriate LLM models for the flow:
|
|
140
|
+
|
|
141
|
+
```yaml
|
|
142
|
+
recommended_models:
|
|
143
|
+
default: "meta-llama/Llama-3.3-70B-Instruct"
|
|
144
|
+
compatible:
|
|
145
|
+
- "microsoft/phi-4"
|
|
146
|
+
- "mistralai/Mixtral-8x7B-Instruct-v0.1"
|
|
147
|
+
experimental:
|
|
148
|
+
- "google/gemini-pro"
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
| Field | Type | Required | Default | Description |
|
|
152
|
+
|-------|------|----------|---------|-------------|
|
|
153
|
+
| `default` | `string` | Yes | - | The default model recommended for this flow. This is the primary model users should use. |
|
|
154
|
+
| `compatible` | `List[string]` | No | `[]` | List of models known to work well with this flow. Alternative options with good performance. |
|
|
155
|
+
| `experimental` | `List[string]` | No | `[]` | List of experimental models that may work but haven't been extensively tested with this flow. |
|
|
156
|
+
|
|
157
|
+
**Model Selection Behavior:**
|
|
158
|
+
|
|
159
|
+
When the framework needs to select a model, it prioritizes in this order:
|
|
160
|
+
1. `default` model if available
|
|
161
|
+
2. First available model from `compatible` list
|
|
162
|
+
3. First available model from `experimental` list
|
|
163
|
+
|
|
164
|
+
#### DatasetRequirements Structure
|
|
165
|
+
|
|
166
|
+
The `dataset_requirements` field validates input datasets and documents expected data format:
|
|
167
|
+
|
|
168
|
+
```yaml
|
|
169
|
+
dataset_requirements:
|
|
170
|
+
required_columns:
|
|
171
|
+
- "document"
|
|
172
|
+
- "context"
|
|
173
|
+
optional_columns:
|
|
174
|
+
- "metadata"
|
|
175
|
+
- "source"
|
|
176
|
+
min_samples: 1
|
|
177
|
+
max_samples: 10000
|
|
178
|
+
column_types:
|
|
179
|
+
document: "string"
|
|
180
|
+
context: "string"
|
|
181
|
+
description: "Documents with context for Q&A generation"
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
| Field | Type | Required | Default | Description |
|
|
185
|
+
|-------|------|----------|---------|-------------|
|
|
186
|
+
| `required_columns` | `List[string]` | No | `[]` | Column names that must be present in the input dataset. Flow validation will fail if these are missing. |
|
|
187
|
+
| `optional_columns` | `List[string]` | No | `[]` | Column names that are optional but can enhance flow performance if provided. |
|
|
188
|
+
| `min_samples` | `integer` | No | `1` | Minimum number of samples required in the input dataset. Must be at least 1. |
|
|
189
|
+
| `max_samples` | `integer` | No | `None` | Maximum number of samples to process. Useful for resource management and preventing excessive processing. |
|
|
190
|
+
| `column_types` | `Dict[string, string]` | No | `{}` | Expected data types for specific columns (e.g., "string", "integer", "float"). Used for documentation purposes. |
|
|
191
|
+
| `description` | `string` | No | `""` | Human-readable description of the dataset requirements and expected format. |
|
|
192
|
+
|
|
193
|
+
**Validation Behavior:**
|
|
194
|
+
|
|
195
|
+
- The flow will validate the input dataset against `required_columns` before execution
|
|
196
|
+
- Missing required columns will cause the flow to fail with a clear error message
|
|
197
|
+
- Sample count validation ensures the dataset meets `min_samples` and respects `max_samples` if set
|
|
198
|
+
- `max_samples` must be greater than or equal to `min_samples` if both are specified
|
|
199
|
+
|
|
200
|
+
#### Complete Metadata Example
|
|
201
|
+
|
|
202
|
+
Here's a comprehensive example using all available metadata fields:
|
|
203
|
+
|
|
204
|
+
```yaml
|
|
205
|
+
metadata:
|
|
206
|
+
name: "Advanced Document Q&A Generation"
|
|
207
|
+
id: "advanced-document-qa-generation"
|
|
208
|
+
description: |
|
|
209
|
+
A sophisticated flow that processes documents to generate high-quality
|
|
210
|
+
question-answer pairs with faithfulness evaluation and quality filtering.
|
|
211
|
+
Designed for educational content and training data generation.
|
|
212
|
+
version: "2.1.0"
|
|
213
|
+
author: "SDG Hub Team"
|
|
214
|
+
license: "Apache-2.0"
|
|
215
|
+
|
|
216
|
+
recommended_models:
|
|
217
|
+
default: "meta-llama/Llama-3.3-70B-Instruct"
|
|
218
|
+
compatible:
|
|
219
|
+
- "microsoft/phi-4"
|
|
220
|
+
- "mistralai/Mixtral-8x7B-Instruct-v0.1"
|
|
221
|
+
- "meta-llama/Llama-3.1-70B-Instruct"
|
|
222
|
+
experimental:
|
|
223
|
+
- "google/gemini-pro"
|
|
224
|
+
- "anthropic/claude-3-opus"
|
|
225
|
+
|
|
226
|
+
tags:
|
|
227
|
+
- "question-generation"
|
|
228
|
+
- "document-processing"
|
|
229
|
+
- "educational"
|
|
230
|
+
- "qa-pairs"
|
|
231
|
+
|
|
232
|
+
dataset_requirements:
|
|
233
|
+
required_columns:
|
|
234
|
+
- "document"
|
|
235
|
+
- "context"
|
|
236
|
+
optional_columns:
|
|
237
|
+
- "domain"
|
|
238
|
+
- "difficulty_level"
|
|
239
|
+
- "source_url"
|
|
240
|
+
min_samples: 10
|
|
241
|
+
max_samples: 5000
|
|
242
|
+
column_types:
|
|
243
|
+
document: "string"
|
|
244
|
+
context: "string"
|
|
245
|
+
domain: "string"
|
|
246
|
+
difficulty_level: "integer"
|
|
247
|
+
description: |
|
|
248
|
+
Input dataset should contain documents with contextual information.
|
|
249
|
+
Each document should be well-formed text suitable for Q&A generation.
|
|
250
|
+
Optional domain and difficulty_level fields help tailor generation.
|
|
251
|
+
```
|
|
120
252
|
|
|
121
253
|
### Blocks Section
|
|
122
254
|
|
|
@@ -572,6 +704,221 @@ Checkpoint directories contain:
|
|
|
572
704
|
- If all samples are completed, Flow skips processing and returns merged results immediately
|
|
573
705
|
- Clean up checkpoint directories manually when no longer needed
|
|
574
706
|
|
|
707
|
+
## 📊 Flow Metrics and Reporting
|
|
708
|
+
|
|
709
|
+
SDG Hub automatically tracks and reports detailed execution metrics for every flow run, providing visibility into performance, data transformations, and success/failure status. This built-in monitoring system helps you understand bottlenecks, debug issues, and optimize your pipelines.
|
|
710
|
+
|
|
711
|
+
### Automatic Metrics Collection
|
|
712
|
+
|
|
713
|
+
The flow execution system automatically collects comprehensive metrics for each block without any configuration required:
|
|
714
|
+
|
|
715
|
+
**Collected Metrics:**
|
|
716
|
+
- **Block Identification** - Block name and type for clear tracking
|
|
717
|
+
- **Execution Time** - Precise timing for each block's execution
|
|
718
|
+
- **Row Changes** - Input and output row counts to track data filtering
|
|
719
|
+
- **Column Changes** - Added and removed columns to understand data transformations
|
|
720
|
+
- **Status** - Success or failure status for each block
|
|
721
|
+
- **Error Details** - Full error messages and types when blocks fail
|
|
722
|
+
|
|
723
|
+
### Rich Console Output
|
|
724
|
+
|
|
725
|
+
After every flow execution (whether successful or failed), a beautifully formatted summary table is automatically displayed in your terminal using the Rich library:
|
|
726
|
+
|
|
727
|
+
```python
|
|
728
|
+
from sdg_hub.core.flow import Flow
|
|
729
|
+
from datasets import Dataset
|
|
730
|
+
|
|
731
|
+
# Load and configure flow
|
|
732
|
+
flow = Flow.from_yaml("path/to/flow.yaml")
|
|
733
|
+
flow.set_model_config(
|
|
734
|
+
model="hosted_vllm/meta-llama/Llama-3.3-70B-Instruct",
|
|
735
|
+
api_base="http://localhost:8000/v1"
|
|
736
|
+
)
|
|
737
|
+
|
|
738
|
+
# Execute flow - metrics displayed automatically at completion
|
|
739
|
+
result = flow.generate(dataset)
|
|
740
|
+
```
|
|
741
|
+
|
|
742
|
+
**Example Console Output:**
|
|
743
|
+
|
|
744
|
+
```
|
|
745
|
+
┌─────────────────── Advanced Document Q&A Generation - Complete ───────────────────┐
|
|
746
|
+
│ Flow Execution Summary │
|
|
747
|
+
│ ┌──────────────────────┬─────────────────┬──────────┬──────────────┬─────────┬──┐│
|
|
748
|
+
│ │ Block Name │ Type │ Duration │ Rows │ Columns │ ││
|
|
749
|
+
│ ├──────────────────────┼─────────────────┼──────────┼──────────────┼─────────┼──┤│
|
|
750
|
+
│ │ backup_document │ DuplicateCol... │ 0.05s │ 100 → 100 │ +1 │ ✓││
|
|
751
|
+
│ │ build_question_... │ PromptBuilder...│ 0.12s │ 100 → 100 │ +1 │ ✓││
|
|
752
|
+
│ │ generate_question │ LLMChatBlock │ 45.30s │ 100 → 100 │ +1 │ ✓││
|
|
753
|
+
│ │ generate_answer │ LLMChatBlock │ 78.45s │ 100 → 100 │ +1 │ ✓││
|
|
754
|
+
│ │ eval_faithfulness... │ LLMChatBlock │ 52.20s │ 100 → 100 │ +1 │ ✓││
|
|
755
|
+
│ │ extract_eval_con... │ LLMParserBlock │ 0.15s │ 100 → 100 │ +2 │ ✓││
|
|
756
|
+
│ │ parse_evaluation │ TextParserBlock │ 0.22s │ 100 → 100 │ +2 │ ✓││
|
|
757
|
+
│ │ filter_faithful │ ColumnValueF... │ 0.08s │ 100 → 87 │ — │ ✓││
|
|
758
|
+
│ ├──────────────────────┼─────────────────┼──────────┼──────────────┼─────────┼──┤│
|
|
759
|
+
│ │ TOTAL │ 8 blocks │ 176.57s │ 87 final │ 9 final │ ✓││
|
|
760
|
+
│ └──────────────────────┴─────────────────┴──────────┴──────────────┴─────────┴──┘│
|
|
761
|
+
└─────────────────────────────────────────────────────────────────────────────────────┘
|
|
762
|
+
```
|
|
763
|
+
|
|
764
|
+
**Table Columns Explained:**
|
|
765
|
+
|
|
766
|
+
| Column | Description |
|
|
767
|
+
|--------|-------------|
|
|
768
|
+
| **Block Name** | The unique name of the block as defined in the flow YAML |
|
|
769
|
+
| **Type** | The block class name (e.g., LLMChatBlock, PromptBuilderBlock) |
|
|
770
|
+
| **Duration** | Execution time in seconds for that specific block |
|
|
771
|
+
| **Rows** | Row transformation showing `input_count → output_count` |
|
|
772
|
+
| **Columns** | Column changes: `+N` for added, `-N` for removed, `+N/-M` for both |
|
|
773
|
+
| **Status** | `✓` for success, `✗` for failure |
|
|
774
|
+
|
|
775
|
+
**Status Indicators:**
|
|
776
|
+
|
|
777
|
+
The panel border color and title reflect the overall execution status:
|
|
778
|
+
|
|
779
|
+
- **Green border + "Complete"** - All blocks executed successfully
|
|
780
|
+
- **Red border + "Failed"** - Flow execution failed (exception thrown)
|
|
781
|
+
- **Yellow border + "Partial"** - Some blocks completed but others failed
|
|
782
|
+
|
|
783
|
+
### JSON Metrics Export
|
|
784
|
+
|
|
785
|
+
For production workflows, detailed metrics can be automatically saved to JSON files for analysis, monitoring, and debugging:
|
|
786
|
+
|
|
787
|
+
```python
|
|
788
|
+
# Enable JSON metrics export by providing a log directory
|
|
789
|
+
result = flow.generate(
|
|
790
|
+
dataset,
|
|
791
|
+
log_dir="./flow_logs"
|
|
792
|
+
)
|
|
793
|
+
|
|
794
|
+
# Metrics automatically saved to: ./flow_logs/{flow_name}_{timestamp}_metrics.json
|
|
795
|
+
```
|
|
796
|
+
|
|
797
|
+
**JSON Structure:**
|
|
798
|
+
|
|
799
|
+
```json
|
|
800
|
+
{
|
|
801
|
+
"flow_name": "Advanced Document Q&A Generation",
|
|
802
|
+
"flow_version": "2.1.0",
|
|
803
|
+
"execution_timestamp": "20250113_143052",
|
|
804
|
+
"execution_successful": true,
|
|
805
|
+
"total_execution_time": 176.57,
|
|
806
|
+
"total_wall_time": 178.23,
|
|
807
|
+
"total_blocks": 8,
|
|
808
|
+
"successful_blocks": 8,
|
|
809
|
+
"failed_blocks": 0,
|
|
810
|
+
"block_metrics": [
|
|
811
|
+
{
|
|
812
|
+
"block_name": "backup_document",
|
|
813
|
+
"block_type": "DuplicateColumnsBlock",
|
|
814
|
+
"execution_time": 0.05,
|
|
815
|
+
"input_rows": 100,
|
|
816
|
+
"output_rows": 100,
|
|
817
|
+
"added_cols": ["original_document"],
|
|
818
|
+
"removed_cols": [],
|
|
819
|
+
"status": "success"
|
|
820
|
+
},
|
|
821
|
+
{
|
|
822
|
+
"block_name": "generate_question",
|
|
823
|
+
"block_type": "LLMChatBlock",
|
|
824
|
+
"execution_time": 45.30,
|
|
825
|
+
"input_rows": 100,
|
|
826
|
+
"output_rows": 100,
|
|
827
|
+
"added_cols": ["question"],
|
|
828
|
+
"removed_cols": [],
|
|
829
|
+
"status": "success"
|
|
830
|
+
}
|
|
831
|
+
]
|
|
832
|
+
}
|
|
833
|
+
```
|
|
834
|
+
|
|
835
|
+
**JSON Fields Reference:**
|
|
836
|
+
|
|
837
|
+
| Field | Type | Description |
|
|
838
|
+
|-------|------|-------------|
|
|
839
|
+
| `flow_name` | string | Human-readable flow name from metadata |
|
|
840
|
+
| `flow_version` | string | Flow version string |
|
|
841
|
+
| `execution_timestamp` | string | Timestamp when execution started (YYYYMMDD_HHMMSS format) |
|
|
842
|
+
| `execution_successful` | boolean | `true` if all blocks succeeded, `false` if any failed |
|
|
843
|
+
| `total_execution_time` | float | Sum of all block execution times in seconds |
|
|
844
|
+
| `total_wall_time` | float | End-to-end wall clock time including overhead |
|
|
845
|
+
| `total_blocks` | integer | Number of blocks in the flow |
|
|
846
|
+
| `successful_blocks` | integer | Count of blocks that executed successfully |
|
|
847
|
+
| `failed_blocks` | integer | Count of blocks that failed |
|
|
848
|
+
| `block_metrics` | array | Detailed metrics for each block (see below) |
|
|
849
|
+
|
|
850
|
+
**Block Metrics Fields:**
|
|
851
|
+
|
|
852
|
+
| Field | Type | Description |
|
|
853
|
+
|-------|------|-------------|
|
|
854
|
+
| `block_name` | string | Unique block identifier |
|
|
855
|
+
| `block_type` | string | Block class name |
|
|
856
|
+
| `execution_time` | float | Block execution duration in seconds |
|
|
857
|
+
| `input_rows` | integer | Number of rows received by the block |
|
|
858
|
+
| `output_rows` | integer | Number of rows produced by the block |
|
|
859
|
+
| `added_cols` | array | List of column names added by this block |
|
|
860
|
+
| `removed_cols` | array | List of column names removed by this block |
|
|
861
|
+
| `status` | string | `"success"` or `"failed"` |
|
|
862
|
+
| `error` | string | Error message (only present if `status` is `"failed"`) |
|
|
863
|
+
| `error_type` | string | Error class name (only present if `status` is `"failed"`) |
|
|
864
|
+
|
|
865
|
+
### Metrics Aggregation
|
|
866
|
+
|
|
867
|
+
When using checkpointing with `save_freq`, blocks may execute multiple times on different chunks of data. The metrics system automatically aggregates these executions per block:
|
|
868
|
+
|
|
869
|
+
- **Execution times** are summed across all chunks
|
|
870
|
+
- **Row counts** are totaled for input and output
|
|
871
|
+
- **Column changes** are merged (duplicates removed)
|
|
872
|
+
- **Status** reflects the worst case (any failure marks the block as failed)
|
|
873
|
+
|
|
874
|
+
This ensures the metrics summary and JSON export always show a cohesive view of the entire flow execution.
|
|
875
|
+
|
|
876
|
+
### Use Cases
|
|
877
|
+
|
|
878
|
+
**Performance Optimization:**
|
|
879
|
+
```python
|
|
880
|
+
# Identify slow blocks for optimization
|
|
881
|
+
result = flow.generate(dataset, log_dir="./optimization_analysis")
|
|
882
|
+
# Review metrics JSON to find blocks with high execution_time
|
|
883
|
+
```
|
|
884
|
+
|
|
885
|
+
**Data Quality Monitoring:**
|
|
886
|
+
```python
|
|
887
|
+
# Track how filtering affects dataset size
|
|
888
|
+
result = flow.generate(dataset)
|
|
889
|
+
# Check console output for row count changes: "100 → 87" indicates 13 filtered
|
|
890
|
+
```
|
|
891
|
+
|
|
892
|
+
**Production Monitoring:**
|
|
893
|
+
```python
|
|
894
|
+
# Continuous metrics collection for production pipelines
|
|
895
|
+
for batch in data_batches:
|
|
896
|
+
result = flow.generate(
|
|
897
|
+
batch,
|
|
898
|
+
log_dir=f"./production_metrics/{date}",
|
|
899
|
+
checkpoint_dir=f"./checkpoints/{batch_id}"
|
|
900
|
+
)
|
|
901
|
+
# Aggregate metrics JSON files for dashboards and alerting
|
|
902
|
+
```
|
|
903
|
+
|
|
904
|
+
**Debugging Failed Runs:**
|
|
905
|
+
```python
|
|
906
|
+
# Automatic error capture in metrics
|
|
907
|
+
try:
|
|
908
|
+
result = flow.generate(dataset, log_dir="./debug_logs")
|
|
909
|
+
except Exception as e:
|
|
910
|
+
# Metrics JSON contains full error details for failed blocks
|
|
911
|
+
print(f"Check ./debug_logs for detailed failure metrics")
|
|
912
|
+
```
|
|
913
|
+
|
|
914
|
+
### Important Notes
|
|
915
|
+
|
|
916
|
+
- **Always Displayed** - Metrics are shown even if the flow fails, helping debug issues
|
|
917
|
+
- **Zero Configuration** - No setup required, metrics collection is automatic
|
|
918
|
+
- **Minimal Overhead** - Metrics collection adds negligible performance impact
|
|
919
|
+
- **Thread-Safe** - Metrics are properly collected during concurrent block execution
|
|
920
|
+
- **Checkpoint Aware** - Metrics correctly aggregate across checkpointed chunks
|
|
921
|
+
|
|
575
922
|
## 🚀 Next Steps
|
|
576
923
|
|
|
577
924
|
Ready to master the flow system? Explore these detailed guides:
|
|
@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
|
|
|
28
28
|
commit_id: COMMIT_ID
|
|
29
29
|
__commit_id__: COMMIT_ID
|
|
30
30
|
|
|
31
|
-
__version__ = version = '0.5.
|
|
32
|
-
__version_tuple__ = version_tuple = (0, 5,
|
|
31
|
+
__version__ = version = '0.5.1'
|
|
32
|
+
__version_tuple__ = version_tuple = (0, 5, 1)
|
|
33
33
|
|
|
34
|
-
__commit_id__ = commit_id = '
|
|
34
|
+
__commit_id__ = commit_id = 'g6cce29580'
|
|
@@ -7,13 +7,16 @@ This module provides the LLMParserBlock for extracting specific fields
|
|
|
7
7
|
|
|
8
8
|
# Standard
|
|
9
9
|
from typing import Any
|
|
10
|
+
from weakref import finalize
|
|
11
|
+
import json
|
|
10
12
|
|
|
11
13
|
# Third Party
|
|
12
|
-
from datasets import Dataset
|
|
14
|
+
from datasets import Dataset, load_dataset
|
|
13
15
|
from pydantic import Field, model_validator
|
|
14
16
|
|
|
15
17
|
# Local
|
|
16
18
|
from ...utils.logger_config import setup_logger
|
|
19
|
+
from ...utils.temp_manager import cleanup_path, create_temp_dir, create_temp_file
|
|
17
20
|
from ..base import BaseBlock
|
|
18
21
|
from ..registry import BlockRegistry
|
|
19
22
|
|
|
@@ -26,6 +29,8 @@ logger = setup_logger(__name__)
|
|
|
26
29
|
"Extracts specified fields from LLM response objects",
|
|
27
30
|
)
|
|
28
31
|
class LLMParserBlock(BaseBlock):
|
|
32
|
+
_flow_requires_jsonl_tmp: bool = True
|
|
33
|
+
|
|
29
34
|
"""Block for extracting fields from LLM response objects.
|
|
30
35
|
|
|
31
36
|
This block extracts specified fields from chat completion response objects.
|
|
@@ -314,7 +319,54 @@ class LLMParserBlock(BaseBlock):
|
|
|
314
319
|
logger.warning("No samples to process, returning empty dataset")
|
|
315
320
|
return Dataset.from_list([])
|
|
316
321
|
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
322
|
+
tmp_jsonl_path = kwargs.get("_flow_tmp_jsonl_path")
|
|
323
|
+
cleanup_locally = False
|
|
324
|
+
|
|
325
|
+
if tmp_jsonl_path is None:
|
|
326
|
+
tmp_jsonl_path = str(
|
|
327
|
+
create_temp_file(
|
|
328
|
+
prefix=f"{self.block_name}_llm_parser", suffix=".jsonl"
|
|
329
|
+
)
|
|
330
|
+
)
|
|
331
|
+
cleanup_locally = True
|
|
332
|
+
|
|
333
|
+
rows_written = 0
|
|
334
|
+
batch = []
|
|
335
|
+
with open(tmp_jsonl_path, "w") as f:
|
|
336
|
+
for sample in samples:
|
|
337
|
+
out = self._generate(sample)
|
|
338
|
+
for row in out:
|
|
339
|
+
batch.append(json.dumps(row) + "\n")
|
|
340
|
+
rows_written += 1
|
|
341
|
+
if len(batch) >= 5:
|
|
342
|
+
f.writelines(batch)
|
|
343
|
+
batch.clear()
|
|
344
|
+
if batch:
|
|
345
|
+
f.writelines(batch)
|
|
346
|
+
|
|
347
|
+
if rows_written == 0:
|
|
348
|
+
if cleanup_locally:
|
|
349
|
+
cleanup_path(tmp_jsonl_path)
|
|
350
|
+
return Dataset.from_list([])
|
|
351
|
+
|
|
352
|
+
hf_cache_dir = None
|
|
353
|
+
try:
|
|
354
|
+
hf_cache_dir = create_temp_dir(
|
|
355
|
+
prefix=f"{self.block_name}_llm_parser_hf_cache"
|
|
356
|
+
)
|
|
357
|
+
ret = load_dataset(
|
|
358
|
+
"json",
|
|
359
|
+
data_files=tmp_jsonl_path,
|
|
360
|
+
split="train",
|
|
361
|
+
keep_in_memory=False,
|
|
362
|
+
cache_dir=str(hf_cache_dir),
|
|
363
|
+
)
|
|
364
|
+
finalize(ret, cleanup_path, hf_cache_dir)
|
|
365
|
+
return ret
|
|
366
|
+
except Exception:
|
|
367
|
+
if hf_cache_dir is not None:
|
|
368
|
+
cleanup_path(hf_cache_dir)
|
|
369
|
+
raise
|
|
370
|
+
finally:
|
|
371
|
+
if cleanup_locally:
|
|
372
|
+
cleanup_path(tmp_jsonl_path)
|
|
@@ -7,14 +7,17 @@ start/end tags, custom regex patterns, and cleanup operations.
|
|
|
7
7
|
|
|
8
8
|
# Standard
|
|
9
9
|
from typing import Any, Optional
|
|
10
|
+
from weakref import finalize
|
|
11
|
+
import json
|
|
10
12
|
import re
|
|
11
13
|
|
|
12
14
|
# Third Party
|
|
13
|
-
from datasets import Dataset
|
|
15
|
+
from datasets import Dataset, load_dataset
|
|
14
16
|
from pydantic import Field, field_validator, model_validator
|
|
15
17
|
|
|
16
18
|
# Local
|
|
17
19
|
from ...utils.logger_config import setup_logger
|
|
20
|
+
from ...utils.temp_manager import cleanup_path, create_temp_dir, create_temp_file
|
|
18
21
|
from ..base import BaseBlock
|
|
19
22
|
from ..registry import BlockRegistry
|
|
20
23
|
|
|
@@ -27,6 +30,8 @@ logger = setup_logger(__name__)
|
|
|
27
30
|
"Parses and post-processes text content using tags or regex patterns",
|
|
28
31
|
)
|
|
29
32
|
class TextParserBlock(BaseBlock):
|
|
33
|
+
_flow_requires_jsonl_tmp: bool = True
|
|
34
|
+
|
|
30
35
|
"""Block for parsing and post-processing text content.
|
|
31
36
|
|
|
32
37
|
This block handles text parsing using start/end tags, custom regex patterns,
|
|
@@ -317,7 +322,54 @@ class TextParserBlock(BaseBlock):
|
|
|
317
322
|
logger.warning("No samples to parse, returning empty dataset")
|
|
318
323
|
return Dataset.from_list([])
|
|
319
324
|
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
325
|
+
tmp_jsonl_path = kwargs.get("_flow_tmp_jsonl_path")
|
|
326
|
+
cleanup_locally = False
|
|
327
|
+
|
|
328
|
+
if tmp_jsonl_path is None:
|
|
329
|
+
tmp_jsonl_path = str(
|
|
330
|
+
create_temp_file(
|
|
331
|
+
prefix=f"{self.block_name}_text_parser", suffix=".jsonl"
|
|
332
|
+
)
|
|
333
|
+
)
|
|
334
|
+
cleanup_locally = True
|
|
335
|
+
|
|
336
|
+
rows_written = 0
|
|
337
|
+
batch = []
|
|
338
|
+
with open(tmp_jsonl_path, "w") as f:
|
|
339
|
+
for sample in samples:
|
|
340
|
+
out = self._generate(sample)
|
|
341
|
+
for row in out:
|
|
342
|
+
batch.append(json.dumps(row) + "\n")
|
|
343
|
+
rows_written += 1
|
|
344
|
+
if len(batch) >= 5:
|
|
345
|
+
f.writelines(batch)
|
|
346
|
+
batch.clear()
|
|
347
|
+
if batch:
|
|
348
|
+
f.writelines(batch)
|
|
349
|
+
|
|
350
|
+
if rows_written == 0:
|
|
351
|
+
if cleanup_locally:
|
|
352
|
+
cleanup_path(tmp_jsonl_path)
|
|
353
|
+
return Dataset.from_list([])
|
|
354
|
+
|
|
355
|
+
hf_cache_dir = None
|
|
356
|
+
try:
|
|
357
|
+
hf_cache_dir = create_temp_dir(
|
|
358
|
+
prefix=f"{self.block_name}_text_parser_hf_cache"
|
|
359
|
+
)
|
|
360
|
+
ret = load_dataset(
|
|
361
|
+
"json",
|
|
362
|
+
data_files=tmp_jsonl_path,
|
|
363
|
+
split="train",
|
|
364
|
+
keep_in_memory=False,
|
|
365
|
+
cache_dir=str(hf_cache_dir),
|
|
366
|
+
)
|
|
367
|
+
finalize(ret, cleanup_path, hf_cache_dir)
|
|
368
|
+
return ret
|
|
369
|
+
except Exception:
|
|
370
|
+
if hf_cache_dir is not None:
|
|
371
|
+
cleanup_path(hf_cache_dir)
|
|
372
|
+
raise
|
|
373
|
+
finally:
|
|
374
|
+
if cleanup_locally:
|
|
375
|
+
cleanup_path(tmp_jsonl_path)
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
from datetime import datetime
|
|
6
6
|
from pathlib import Path
|
|
7
7
|
from typing import Any, Optional, Union
|
|
8
|
+
from weakref import finalize
|
|
9
|
+
import gc
|
|
8
10
|
import time
|
|
9
11
|
import uuid
|
|
10
12
|
|
|
@@ -37,6 +39,11 @@ from ..utils.flow_metrics import (
|
|
|
37
39
|
)
|
|
38
40
|
from ..utils.logger_config import setup_logger
|
|
39
41
|
from ..utils.path_resolution import resolve_path
|
|
42
|
+
from ..utils.temp_manager import (
|
|
43
|
+
cleanup_path,
|
|
44
|
+
create_temp_dir,
|
|
45
|
+
create_temp_file,
|
|
46
|
+
)
|
|
40
47
|
from ..utils.time_estimator import estimate_execution_time
|
|
41
48
|
from ..utils.yaml_utils import save_flow_yaml
|
|
42
49
|
from .checkpointer import FlowCheckpointer
|
|
@@ -580,6 +587,7 @@ class Flow(BaseModel):
|
|
|
580
587
|
# Use provided logger or fall back to global logger
|
|
581
588
|
exec_logger = flow_logger if flow_logger is not None else logger
|
|
582
589
|
current_dataset = dataset
|
|
590
|
+
current_dataset_temp_path: Optional[Path] = None
|
|
583
591
|
|
|
584
592
|
# Execute blocks in sequence
|
|
585
593
|
for i, block in enumerate(self.blocks):
|
|
@@ -591,6 +599,14 @@ class Flow(BaseModel):
|
|
|
591
599
|
# Prepare block execution parameters
|
|
592
600
|
block_kwargs = self._prepare_block_kwargs(block, runtime_params)
|
|
593
601
|
|
|
602
|
+
block_temp_jsonl_path: Optional[Path] = None
|
|
603
|
+
dataset_temp_dir: Optional[Path] = None
|
|
604
|
+
if getattr(block, "_flow_requires_jsonl_tmp", False):
|
|
605
|
+
block_temp_jsonl_path = create_temp_file(
|
|
606
|
+
prefix=f"{block.block_name}_parser", suffix=".jsonl"
|
|
607
|
+
)
|
|
608
|
+
block_kwargs["_flow_tmp_jsonl_path"] = str(block_temp_jsonl_path)
|
|
609
|
+
|
|
594
610
|
# Add max_concurrency to block kwargs if provided
|
|
595
611
|
if max_concurrency is not None:
|
|
596
612
|
block_kwargs["_flow_max_concurrency"] = max_concurrency
|
|
@@ -610,6 +626,28 @@ class Flow(BaseModel):
|
|
|
610
626
|
f"Block '{block.block_name}' produced empty dataset"
|
|
611
627
|
)
|
|
612
628
|
|
|
629
|
+
# Here, we write and reload dataset object from and to disk.
|
|
630
|
+
# This is done because HF Datasets library creates a ton of intermediate
|
|
631
|
+
# objects, and holds on to them even after the objects have fulfilled
|
|
632
|
+
# their purpose. To get flush these objects, HF recommends to implement
|
|
633
|
+
# this `save_to_disk` and `load_from_disk` hack.
|
|
634
|
+
# https://github.com/huggingface/datasets/blob/main/src/datasets/arrow_dataset.py#L1029
|
|
635
|
+
previous_temp_path = current_dataset_temp_path
|
|
636
|
+
dataset_temp_dir = create_temp_dir(prefix=f"flow_{block.block_name}")
|
|
637
|
+
current_dataset.save_to_disk(str(dataset_temp_dir))
|
|
638
|
+
del current_dataset
|
|
639
|
+
gc.collect()
|
|
640
|
+
current_dataset = datasets.load_from_disk(
|
|
641
|
+
str(dataset_temp_dir), keep_in_memory=False
|
|
642
|
+
)
|
|
643
|
+
finalize(current_dataset, cleanup_path, dataset_temp_dir)
|
|
644
|
+
current_dataset_temp_path = dataset_temp_dir
|
|
645
|
+
if previous_temp_path and previous_temp_path != dataset_temp_dir:
|
|
646
|
+
cleanup_path(previous_temp_path)
|
|
647
|
+
|
|
648
|
+
if block_temp_jsonl_path is not None:
|
|
649
|
+
cleanup_path(block_temp_jsonl_path)
|
|
650
|
+
|
|
613
651
|
# Capture metrics after successful execution
|
|
614
652
|
execution_time = time.perf_counter() - start_time
|
|
615
653
|
output_rows = len(current_dataset)
|
|
@@ -638,6 +676,10 @@ class Flow(BaseModel):
|
|
|
638
676
|
)
|
|
639
677
|
|
|
640
678
|
except Exception as exc:
|
|
679
|
+
if block_temp_jsonl_path is not None:
|
|
680
|
+
cleanup_path(block_temp_jsonl_path)
|
|
681
|
+
if dataset_temp_dir is not None:
|
|
682
|
+
cleanup_path(dataset_temp_dir)
|
|
641
683
|
# Capture metrics for failed execution
|
|
642
684
|
execution_time = time.perf_counter() - start_time
|
|
643
685
|
self._block_metrics.append(
|
|
@@ -661,6 +703,13 @@ class Flow(BaseModel):
|
|
|
661
703
|
f"Block '{block.block_name}' execution failed: {exc}"
|
|
662
704
|
) from exc
|
|
663
705
|
|
|
706
|
+
if current_dataset_temp_path is not None:
|
|
707
|
+
final_temp_path = current_dataset_temp_path
|
|
708
|
+
current_dataset = datasets.load_from_disk(
|
|
709
|
+
str(final_temp_path), keep_in_memory=True
|
|
710
|
+
)
|
|
711
|
+
cleanup_path(final_temp_path)
|
|
712
|
+
|
|
664
713
|
return current_dataset
|
|
665
714
|
|
|
666
715
|
def _prepare_block_kwargs(
|