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

✨ Add Core Workflow Examples #287

Merged
merged 9 commits into from
Feb 6, 2024
Merged

✨ Add Core Workflow Examples #287

merged 9 commits into from
Feb 6, 2024

Conversation

MFA-X-AI
Copy link
Member

@MFA-X-AI MFA-X-AI commented Feb 6, 2024

Description

This PR introduces 6 new examples, each designed to illustrate fundamental concepts and features in Xircuits.

  • HelloXircuits: Basic workflow that introduces parameters and nodes.
  • ArgumentParameters: Demonstrates Argument parameter input in workflows.
  • CompulsoryPorts: Shows mandatory data inputs for components.
  • DynamicPorts: Highlights expandible inPorts in components.
  • SettingVariables: Illustrates a method to define, set, and get variables.
  • XircuitsContext: Explains ctx sharing across components.
  • ControlFlowExample: Showcases an example of a if control flow mechanism.

This PR also

  • updates Argument nodes from incorrectly showing an empty tooltip
  • packages the examples directory into the wheel, and have the examples pulled from the wheel instead of the repository
  • enable gh action for wheel building and ui tests to run on specified branches.

References

#284

Pull Request Type

  • Xircuits Core (Jupyterlab Related changes)
  • Xircuits Canvas (Custom RD Related changes)
  • Xircuits Component Library
  • Xircuits Project Template
  • Testing Automation
  • Documentation
  • Others: Workflow Examples

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Tests

Test A: Try

  1. Install xircuits from the wheel. run xircuits examples.
  2. Verify that the examples directory is present in the current working directory.

Test B: Run All Workflow Examples

  1. Navigate to the examples directory.
  2. Try out each workflow example (HelloXircuits, ArgumentParameters, CompulsoryPorts, DynamicPorts, SettingVariables, XircuitsContext, ControlFlowExample).
  3. Confirm that each example runs successfully and outputs the expected results without errors.

Tested on?

  • Windows
  • Linux Ubuntu
  • Centos
  • Mac
  • Others (State here -> xxx )

Notes

@MFA-X-AI MFA-X-AI force-pushed the fahreza/core-examples branch from 288a44d to 9d603a1 Compare February 6, 2024 13:52
@MFA-X-AI MFA-X-AI force-pushed the fahreza/core-examples branch from e599419 to 4139188 Compare February 6, 2024 17:44
@MFA-X-AI MFA-X-AI merged commit b41559d into master Feb 6, 2024
8 checks passed
@MFA-X-AI MFA-X-AI deleted the fahreza/core-examples branch February 6, 2024 18:08
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 this pull request may close these issues.

1 participant