flowcept 0.8.7__tar.gz → 0.8.9__tar.gz

{flowcept-0.8.7 → flowcept-0.8.9}/.github/workflows/create-release-n-publish.yml

@@ -25,9 +25,11 @@ jobs:
 
       - name: Update version.py
         run: |
+          pip install .[dev]
           export PYTHONPATH=$PYTHONPATH:flowcept
           cat resources/sample_settings.yaml
           python .github/workflows/version_bumper.py
+          echo "After version_bumper.py"
           cat src/flowcept/version.py
           cat resources/sample_settings.yaml
           git status

flowcept-0.8.9/.github/workflows/version_bumper.py

@@ -0,0 +1,54 @@
+# This script ensures consistent and automatic version updates across the project.
+#
+# We often forget to manually update the version string in all the necessary places,
+# especially during merges to the main branch. To avoid human error and ensure
+# systematic versioning, we run this script as part of our main branch merge process in the CI.
+#
+# It performs the following:
+# - Reads the current version from src/flowcept/version.py
+# - Increments the patch number (e.g., 0.1.4 -> 0.1.5)
+# - Updates version.py with the new version
+# - Reads the current flowcept_version from resources/sample_settings.yaml
+# - Replaces the old version with the new one using simple string replacement (not YAML dumping)
+#
+# This guarantees that both source code and configuration files remain synchronized with respect to versioning.
+
+
+import re
+import yaml
+
+version_file_path = "src/flowcept/version.py"
+with open(version_file_path) as f:
+    code_str = f.read()
+    exec(code_str)
+    version = locals()["__version__"]
+
+split_version = version.split(".")
+old_patch_str = split_version[2]
+re_found = re.findall(r"(\d+)(.*)", old_patch_str)[0]
+old_patch_number = re_found[0]
+
+new_patch_str = old_patch_str.replace(old_patch_number, str(int(old_patch_number) + 1))
+
+split_version[2] = new_patch_str
+new_version = ".".join(split_version)
+
+print("New version: " + new_version)
+new_code_str = code_str.replace(version, new_version)
+
+with open(version_file_path, "w") as f:
+    f.write(new_code_str)
+
+yaml_file_path = "resources/sample_settings.yaml"
+with open(yaml_file_path) as f:
+    yaml_data = yaml.safe_load(f)
+    old_yaml_version = yaml_data.get("flowcept_version")
+
+# Replace the old version string with the new one using str.replace()
+with open(yaml_file_path) as f:
+    yaml_text = f.read()
+
+new_yaml_text = yaml_text.replace(f"flowcept_version: {old_yaml_version}", f"flowcept_version: {new_version}")
+
+with open(yaml_file_path, "w") as f:
+    f.write(new_yaml_text)

{flowcept-0.8.7 → flowcept-0.8.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flowcept
-Version: 0.8.7
+Version: 0.8.9
 Summary: Capture and query workflow provenance data using data observability
 Project-URL: GitHub, https://github.com/ORNL/flowcept
 Author: Oak Ridge National Laboratory
@@ -88,6 +88,7 @@ Requires-Dist: tensorboard; extra == 'tensorboard'
 Requires-Dist: tensorflow; extra == 'tensorboard'
 Description-Content-Type: text/markdown
 
+[![Documentation](https://img.shields.io/badge/docs-readthedocs.io-green.svg)](https://flowcept.readthedocs.io/)
 [![Build](https://github.com/ORNL/flowcept/actions/workflows/create-release-n-publish.yml/badge.svg)](https://github.com/ORNL/flowcept/actions/workflows/create-release-n-publish.yml)
 [![PyPI](https://badge.fury.io/py/flowcept.svg)](https://pypi.org/project/flowcept)
 [![Tests](https://github.com/ORNL/flowcept/actions/workflows/run-tests.yml/badge.svg)](https://github.com/ORNL/flowcept/actions/workflows/run-tests.yml)
@@ -107,6 +108,7 @@ Description-Content-Type: text/markdown
 - [Data Persistence](#data-persistence)
 - [Performance Tuning](#performance-tuning-for-performance-evaluation)
 - [AMD GPU Setup](#install-amd-gpu-lib)
+- [Further Documentation](#documentation)
 
 ## Overview
 
@@ -359,6 +361,10 @@ Which was installed using Frontier's /opt/rocm-6.3.1/share/amd_smi
 
 Some unit tests utilize `torch==2.2.2`, `torchtext=0.17.2`, and `torchvision==0.17.2`. They are only really needed to run some tests and will be installed if you run `pip install flowcept[ml_dev]` or `pip install flowcept[all]`. If you want to use Flowcept with Torch, please adapt torch dependencies according to your project's dependencies.
 
+## Documentation
+
+Full documentation is available on [Read the Docs](https://myproject.readthedocs.io/en/latest/).
+
 ## Cite us
 
 If you used Flowcept in your research, consider citing our paper.

{flowcept-0.8.7 → flowcept-0.8.9}/README.md

@@ -1,3 +1,4 @@
+[![Documentation](https://img.shields.io/badge/docs-readthedocs.io-green.svg)](https://flowcept.readthedocs.io/)
 [![Build](https://github.com/ORNL/flowcept/actions/workflows/create-release-n-publish.yml/badge.svg)](https://github.com/ORNL/flowcept/actions/workflows/create-release-n-publish.yml)
 [![PyPI](https://badge.fury.io/py/flowcept.svg)](https://pypi.org/project/flowcept)
 [![Tests](https://github.com/ORNL/flowcept/actions/workflows/run-tests.yml/badge.svg)](https://github.com/ORNL/flowcept/actions/workflows/run-tests.yml)
@@ -17,6 +18,7 @@
 - [Data Persistence](#data-persistence)
 - [Performance Tuning](#performance-tuning-for-performance-evaluation)
 - [AMD GPU Setup](#install-amd-gpu-lib)
+- [Further Documentation](#documentation)
 
 ## Overview
 
@@ -269,6 +271,10 @@ Which was installed using Frontier's /opt/rocm-6.3.1/share/amd_smi
 
 Some unit tests utilize `torch==2.2.2`, `torchtext=0.17.2`, and `torchvision==0.17.2`. They are only really needed to run some tests and will be installed if you run `pip install flowcept[ml_dev]` or `pip install flowcept[all]`. If you want to use Flowcept with Torch, please adapt torch dependencies according to your project's dependencies.
 
+## Documentation
+
+Full documentation is available on [Read the Docs](https://myproject.readthedocs.io/en/latest/).
+
 ## Cite us
 
 If you used Flowcept in your research, consider citing our paper.

{flowcept-0.8.7 → flowcept-0.8.9}/docs/getstarted.rst

@@ -2,7 +2,7 @@ Getting Started
 ===============
 
 Quick Install
-=============
+----------------------------------------------------------------------------------------------
 
 To install Flowcept with its default dependencies, simply run:
 
@@ -15,7 +15,7 @@ This will install the core Flowcept package. For additional adapters or features
 
 
 Start Up Services
-=================
+----------------------------------------------------------------------------------------------
 
 To start required services like the default Redis MQ system, use the provided Makefile target:
 
@@ -35,13 +35,14 @@ If you need MongoDB, you'll run:
 For more options, see the `deployment directory <https://github.com/ORNL/flowcept/tree/main/deployment>`_.
 
 Customizing Settings
-====================
+----------------------------------------------------------------------------------------------
 
 Flowcept allows extensive configuration via a YAML file. To use a custom configuration, set the environment variable
 ``FLOWCEPT_SETTINGS_PATH`` to point to the absolute path of your settings file. A sample file is provided at For more options, see the `sample_settings.yaml <https://github.com/ORNL/flowcept/blob/main/resources/sample_settings.yaml>`_.
 
 Key Settings to Adjust
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 
 - **Service Connections:** Set host, port, and credentials for MQ (`mq:`), key-value DB (`kv_db:`), and optionally MongoDB (`mongodb:`).
 - **Telemetry:** Toggle `cpu`, `mem`, `gpu`, `disk`, `network`, and `process_info` under `telemetry_capture:`.
@@ -53,7 +54,7 @@ Note that if using Redis, MQ and KV_DB are have same host. Refer to the sample s
 
 
 Usage Example with Instrumentation
-==================================
+----------------------------------------------------------------------------------------------
 
 Flowcept supports decorator-based instrumentation for capturing workflow execution data. Here's a simple example:
 
@@ -79,15 +80,15 @@ Flowcept supports decorator-based instrumentation for capturing workflow executi
 
 
 Usage with Data Observability Adapters
-======================================
+----------------------------------------------------------------------------------------------
 
 Flowcept includes adapters for MLFlow, Dask, and TensorBoard that can automatically capture provenance data.
 
 For detailed usage and example configurations, refer to the `examples directory <https://github.com/ORNL/flowcept/tree/main/examples>`_.
 
 
-Querying with Flowcept.db.query
-===============================
+Querying
+----------------------------------------------------------------------------------------------
 
 Once data is captured and persisted (e.g., to MongoDB), you can use Flowcept’s query interface:
 

{flowcept-0.8.7 → flowcept-0.8.9}/docs/index.rst

@@ -1,6 +1,8 @@
 Flowcept
 ========
 
+GitHub Repository: https://github.com/ornl/flowcept
+
 Flowcept is a runtime data integration system that captures and queries workflow provenance with minimal or no code changes. It unifies data across diverse workflows and tools, enabling integrated analysis and insights, especially in federated environments. Designed for scenarios involving critical data from multiple workflows, Flowcept seamlessly integrates data at runtime, providing a unified view for end-to-end monitoring and analysis, and enhanced support for Machine Learning (ML) workflows.
 
 

{flowcept-0.8.7 → flowcept-0.8.9}/docs/task_schema.rst

@@ -84,9 +84,10 @@ If telemetry data capture is enabled, telemetry data is captured both at the sta
   GPU telemetry data, if available, is stored in the `gpu` field. Its structure varies based on the vendor:
 
   - **Common Fields**
+
     - **gpu_ix**: Index of the GPU used (int)
     - **used**: Memory used (bytes)
-    - **temperature**: Dictionary of temperature data
+    - **temperature**: Dictionary of temperature data or int (see below)
     - **power**: Dictionary or value representing power usage
     - **id**: Device UUID
     - **name** (NVIDIA only): GPU name
@@ -94,18 +95,20 @@ If telemetry data capture is enabled, telemetry data is captured both at the sta
     - **others** (AMD only): Additional clock and performance data
 
   - **AMD GPU**:
+
     - **temperature**:
-      - **edge**, **hotspot**, **mem**, **vrgfx**, **vrmem**, **hbm**, **fan_speed**
+      - edge, hotspot, mem, vrgfx, vrmem, hbm, fan_speed
     - **power**:
-      - **average_socket_power**, **energy_accumulator**
+      - average_socket_power, energy_accumulator
     - **others**:
-      - **current_gfxclk**, **current_socclk**, **current_uclk**, **current_vclk0**, **current_dclk0**
+      - current_gfxclk, current_socclk, current_uclk, current_vclk0, current_dclk0
 
   - **NVIDIA GPU**:
+
     - **temperature**: GPU temperature in Celsius
     - **power**: Power usage in milliwatts
     - **used**: Memory used in bytes
     - **name**: GPU model name
     - **id**: Device UUID
 
-Telemetry values may vary depending on system capabilities, permissions, and configuration.
+Telemetry values may vary depending on system capabilities, what is available in the GPU API, and what is enable in the settings.yaml file.

{flowcept-0.8.7 → flowcept-0.8.9}/resources/sample_settings.yaml

@@ -1,4 +1,4 @@
-flowcept_version: 0.8.0 # Version of the Flowcept package. This setting file is compatible with this version.
+flowcept_version: 0.8.9 # Version of the Flowcept package. This setting file is compatible with this version.
 
 project:
   debug: true # Toggle debug mode. This will add a property `debug: true` to all saved data, making it easier to retrieve/delete them later.

{flowcept-0.8.7 → flowcept-0.8.9}/src/flowcept/version.py

@@ -4,4 +4,4 @@
 # The expected format is: <Major>.<Minor>.<Patch>
 # This file is supposed to be automatically modified by the CI Bot.
 # See .github/workflows/version_bumper.py
-__version__ = "0.8.7"
+__version__ = "0.8.9"

flowcept-0.8.7/.github/workflows/version_bumper.py

@@ -1,33 +0,0 @@
-import re
-
-version_file_path = "src/flowcept/version.py"
-with open(version_file_path) as f:
-    code_str = f.read()
-    exec(code_str)
-    version = locals()["__version__"]
-
-split_version = version.split(".")
-old_patch_str = split_version[2]
-re_found = re.findall(r"(\d+)(.*)", old_patch_str)[0]
-old_patch_number = re_found[0]
-
-new_patch_str = old_patch_str.replace(old_patch_number, str(int(old_patch_number) + 1))
-
-split_version[2] = new_patch_str
-new_version = ".".join(split_version)
-
-print("New version: " + new_version)
-new_code_str = code_str.replace(version, new_version)
-
-with open(version_file_path, "w") as f:
-    f.write(new_code_str)
-
-# Update version in sample_settings.yaml using str.replace()
-yaml_file_path = "resources/sample_settings.yaml"
-with open(yaml_file_path) as f:
-    yaml_text = f.read()
-
-new_yaml_text = yaml_text.replace(f"flowcept_version: {version}", f"flowcept_version: {new_version}")
-
-with open(yaml_file_path, "w") as f:
-    f.write(new_yaml_text)