flowcept 0.8.8__tar.gz → 0.8.9__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flowcept
-Version: 0.8.8
+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.8 → 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.8 → flowcept-0.8.9}/docs/getstarted.rst

@@ -40,7 +40,8 @@ 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**
+Key Settings to Adjust
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 - **Service Connections:** Set host, port, and credentials for MQ (`mq:`), key-value DB (`kv_db:`), and optionally MongoDB (`mongodb:`).

{flowcept-0.8.8 → 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.8 → flowcept-0.8.9}/resources/sample_settings.yaml

@@ -1,4 +1,4 @@
-flowcept_version: 0.8.8 # 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.8 → 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.8"
+__version__ = "0.8.9"