Metadata-Version: 2.3
Name: xircuits
Version: 1.10.5
Dynamic: Keywords
Summary: A JupyterLab extension for rendering and editing xircuit files.
Project-URL: Homepage, https://github.com/XpressAI/xircuits
Project-URL: Bug Tracker, https://github.com/XpressAI/xircuits/issues
Project-URL: Repository, https://github.com/XpressAI/xircuits.git
Author-email: Xpress AI <eduardo@xpress.ai>
License: Apache License
                                           Version 2.0, January 2004
                                        http://www.apache.org/licenses/
                
                   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
                
                   1. Definitions.
                
                      "License" shall mean the terms and conditions for use, reproduction,
                      and distribution as defined by Sections 1 through 9 of this document.
                
                      "Licensor" shall mean the copyright owner or entity authorized by
                      the copyright owner that is granting the License.
                
                      "Legal Entity" shall mean the union of the acting entity and all
                      other entities that control, are controlled by, or are under common
                      control with that entity. For the purposes of this definition,
                      "control" means (i) the power, direct or indirect, to cause the
                      direction or management of such entity, whether by contract or
                      otherwise, or (ii) ownership of fifty percent (50%) or more of the
                      outstanding shares, or (iii) beneficial ownership of such entity.
                
                      "You" (or "Your") shall mean an individual or Legal Entity
                      exercising permissions granted by this License.
                
                      "Source" form shall mean the preferred form for making modifications,
                      including but not limited to software source code, documentation
                      source, and configuration files.
                
                      "Object" form shall mean any form resulting from mechanical
                      transformation or translation of a Source form, including but
                      not limited to compiled object code, generated documentation,
                      and conversions to other media types.
                
                      "Work" shall mean the work of authorship, whether in Source or
                      Object form, made available under the License, as indicated by a
                      copyright notice that is included in or attached to the work
                      (an example is provided in the Appendix below).
                
                      "Derivative Works" shall mean any work, whether in Source or Object
                      form, that is based on (or derived from) the Work and for which the
                      editorial revisions, annotations, elaborations, or other modifications
                      represent, as a whole, an original work of authorship. For the purposes
                      of this License, Derivative Works shall not include works that remain
                      separable from, or merely link (or bind by name) to the interfaces of,
                      the Work and Derivative Works thereof.
                
                      "Contribution" shall mean any work of authorship, including
                      the original version of the Work and any modifications or additions
                      to that Work or Derivative Works thereof, that is intentionally
                      submitted to Licensor for inclusion in the Work by the copyright owner
                      or by an individual or Legal Entity authorized to submit on behalf of
                      the copyright owner. For the purposes of this definition, "submitted"
                      means any form of electronic, verbal, or written communication sent
                      to the Licensor or its representatives, including but not limited to
                      communication on electronic mailing lists, source code control systems,
                      and issue tracking systems that are managed by, or on behalf of, the
                      Licensor for the purpose of discussing and improving the Work, but
                      excluding communication that is conspicuously marked or otherwise
                      designated in writing by the copyright owner as "Not a Contribution."
                
                      "Contributor" shall mean Licensor and any individual or Legal Entity
                      on behalf of whom a Contribution has been received by Licensor and
                      subsequently incorporated within the Work.
                
                   2. Grant of Copyright License. Subject to the terms and conditions of
                      this License, each Contributor hereby grants to You a perpetual,
                      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
                      copyright license to reproduce, prepare Derivative Works of,
                      publicly display, publicly perform, sublicense, and distribute the
                      Work and such Derivative Works in Source or Object form.
                
                   3. Grant of Patent License. Subject to the terms and conditions of
                      this License, each Contributor hereby grants to You a perpetual,
                      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
                      (except as stated in this section) patent license to make, have made,
                      use, offer to sell, sell, import, and otherwise transfer the Work,
                      where such license applies only to those patent claims licensable
                      by such Contributor that are necessarily infringed by their
                      Contribution(s) alone or by combination of their Contribution(s)
                      with the Work to which such Contribution(s) was submitted. If You
                      institute patent litigation against any entity (including a
                      cross-claim or counterclaim in a lawsuit) alleging that the Work
                      or a Contribution incorporated within the Work constitutes direct
                      or contributory patent infringement, then any patent licenses
                      granted to You under this License for that Work shall terminate
                      as of the date such litigation is filed.
                
                   4. Redistribution. You may reproduce and distribute copies of the
                      Work or Derivative Works thereof in any medium, with or without
                      modifications, and in Source or Object form, provided that You
                      meet the following conditions:
                
                      (a) You must give any other recipients of the Work or
                          Derivative Works a copy of this License; and
                
                      (b) You must cause any modified files to carry prominent notices
                          stating that You changed the files; and
                
                      (c) You must retain, in the Source form of any Derivative Works
                          that You distribute, all copyright, patent, trademark, and
                          attribution notices from the Source form of the Work,
                          excluding those notices that do not pertain to any part of
                          the Derivative Works; and
                
                      (d) If the Work includes a "NOTICE" text file as part of its
                          distribution, then any Derivative Works that You distribute must
                          include a readable copy of the attribution notices contained
                          within such NOTICE file, excluding those notices that do not
                          pertain to any part of the Derivative Works, in at least one
                          of the following places: within a NOTICE text file distributed
                          as part of the Derivative Works; within the Source form or
                          documentation, if provided along with the Derivative Works; or,
                          within a display generated by the Derivative Works, if and
                          wherever such third-party notices normally appear. The contents
                          of the NOTICE file are for informational purposes only and
                          do not modify the License. You may add Your own attribution
                          notices within Derivative Works that You distribute, alongside
                          or as an addendum to the NOTICE text from the Work, provided
                          that such additional attribution notices cannot be construed
                          as modifying the License.
                
                      You may add Your own copyright statement to Your modifications and
                      may provide additional or different license terms and conditions
                      for use, reproduction, or distribution of Your modifications, or
                      for any such Derivative Works as a whole, provided Your use,
                      reproduction, and distribution of the Work otherwise complies with
                      the conditions stated in this License.
                
                   5. Submission of Contributions. Unless You explicitly state otherwise,
                      any Contribution intentionally submitted for inclusion in the Work
                      by You to the Licensor shall be under the terms and conditions of
                      this License, without any additional terms or conditions.
                      Notwithstanding the above, nothing herein shall supersede or modify
                      the terms of any separate license agreement you may have executed
                      with Licensor regarding such Contributions.
                
                   6. Trademarks. This License does not grant permission to use the trade
                      names, trademarks, service marks, or product names of the Licensor,
                      except as required for reasonable and customary use in describing the
                      origin of the Work and reproducing the content of the NOTICE file.
                
                   7. Disclaimer of Warranty. Unless required by applicable law or
                      agreed to in writing, Licensor provides the Work (and each
                      Contributor provides its Contributions) on an "AS IS" BASIS,
                      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
                      implied, including, without limitation, any warranties or conditions
                      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
                      PARTICULAR PURPOSE. You are solely responsible for determining the
                      appropriateness of using or redistributing the Work and assume any
                      risks associated with Your exercise of permissions under this License.
                
                   8. Limitation of Liability. In no event and under no legal theory,
                      whether in tort (including negligence), contract, or otherwise,
                      unless required by applicable law (such as deliberate and grossly
                      negligent acts) or agreed to in writing, shall any Contributor be
                      liable to You for damages, including any direct, indirect, special,
                      incidental, or consequential damages of any character arising as a
                      result of this License or out of the use or inability to use the
                      Work (including but not limited to damages for loss of goodwill,
                      work stoppage, computer failure or malfunction, or any and all
                      other commercial damages or losses), even if such Contributor
                      has been advised of the possibility of such damages.
                
                   9. Accepting Warranty or Additional Liability. While redistributing
                      the Work or Derivative Works thereof, You may choose to offer,
                      and charge a fee for, acceptance of support, warranty, indemnity,
                      or other liability obligations and/or rights consistent with this
                      License. However, in accepting such obligations, You may act only
                      on Your own behalf and on Your sole responsibility, not on behalf
                      of any other Contributor, and only if You agree to indemnify,
                      defend, and hold each Contributor harmless for any liability
                      incurred by, or claims asserted against, such Contributor by reason
                      of your accepting any such warranty or additional liability.
                
                   END OF TERMS AND CONDITIONS
                
                   APPENDIX: How to apply the Apache License to your work.
                
                      To apply the Apache License to your work, attach the following
                      boilerplate notice, with the fields enclosed by brackets "[]"
                      replaced with your own identifying information. (Don't include
                      the brackets!)  The text should be enclosed in the appropriate
                      comment syntax for the file format. We also recommend that a
                      file or class name and description of purpose be included on the
                      same "printed page" as the copyright notice for easier
                      identification within third-party archives.
                
                   Copyright [yyyy] [name of copyright owner]
                
                   Licensed under the Apache License, Version 2.0 (the "License");
                   you may not use this file except in compliance with the License.
                   You may obtain a copy of the License at
                
                       http://www.apache.org/licenses/LICENSE-2.0
                
                   Unless required by applicable law or agreed to in writing, software
                   distributed under the License is distributed on an "AS IS" BASIS,
                   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
                   See the License for the specific language governing permissions and
                   limitations under the License.
License-File: LICENSE
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Requires-Dist: gitpython
Requires-Dist: jupyter-server<3,>=2.0.1
Requires-Dist: jupyterlab<4.1,>=4.0.0
Requires-Dist: pygithub
Requires-Dist: requests
Requires-Dist: toml
Requires-Dist: tqdm
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-asyncio; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-jupyter[server]>=0.6.0; extra == 'test'
Description-Content-Type: text/markdown

<p align="center">
<img src="https://user-images.githubusercontent.com/68586800/151280601-7ff2b7b2-10e5-4544-b3df-aa6a5a654dae.png" width="450"/>
</p>

<p align="center">
  <a href="https://xircuits.io/">Docs</a> •
  <a href="https://xircuits.io/docs/Installation">Install</a> •
  <a href="https://xircuits.io/docs/category/tutorials">Tutorials</a> •
  <a href="https://xircuits.io/docs/category/developer-guide">Developer Guides</a> •
  <a href="https://github.com/XpressAI/xircuits/blob/master/CONTRIBUTING.md">Contribute</a> •
  <a href="https://www.xpress.ai/blog/">Blog</a> •
  <a href="https://discord.com/invite/vgEg2ZtxCw">Discord</a>
<br>
  <a href="https://github.com/XpressAI/xircuits/tree/master/xai_components#xircuits-component-library-list">Component Libraries</a> •
  <a href="https://github.com/XpressAI/xircuits/tree/master/project-templates#xircuits-project-templates-list">Project Templates</a>
</p>

<p>
  <p align="center">
    <a href="https://github.com/XpressAI/xircuits/blob/master/LICENSE">
        <img alt="GitHub" src="https://img.shields.io/github/license/XpressAI/xircuits?color=brightgreen">
    </a>
    <a href="https://github.com/XpressAI/xircuits/releases">
        <img alt="GitHub release" src="https://img.shields.io/github/release/XpressAI/xircuits.svg?color=yellow">
    </a>
    <a href="https://mybinder.org/v2/gh/XpressAi/xircuits/main?urlpath=lab">
        <img alt="Binder" src="https://mybinder.org/badge_logo.svg">
    </a>
    <a href="https://xircuits.io">
        <img alt="Documentation" src="https://img.shields.io/website/http/xircuits.io.svg?color=orange">
    </a>
     <a>
        <img alt="Python" src="https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue">
    </a>
</p>

![1 10 release](https://github.com/XpressAI/xircuits/assets/68586800/242630dd-4583-4f39-9b37-daa3dc413262)


Xircuits is a Jupyterlab-based extension that enables visual, low-code, training workflows. It allows anyone to easily create executable python code in seconds.

# Features

<details>
  <summary><b>Rich Xircuits Canvas Interface</b></summary>
  <br>
  <p align="center">Unreal Engine-like Chain Component Interface<br>
  <img src=https://user-images.githubusercontent.com/68586800/165813394-3d81e135-1c40-42c6-b480-7cba48114c1c.gif
 width="600"></p>

  <p align="center">Custom Nodes and Ports<br>
  <img src=https://user-images.githubusercontent.com/84708008/161918620-34e20908-f32d-406b-8e47-104e91249472.gif width="600"></p>
  
  <p align="center">Smart Link and Type Check Logic<br>
  <img src=https://user-images.githubusercontent.com/84708008/165257379-77776d0e-8b20-4ef9-820b-40b9e80697e4.gif width="600"></p>
  
  <p align="center">Component Tooltips<br>
  <img src=https://user-images.githubusercontent.com/84708008/163518580-186d4298-3344-4280-a87a-67be90eec13f.gif width="600"></p>

  <p align="center">Dynamic Ports<br>
  <img src=https://user-images.githubusercontent.com/68586800/270856813-47c39215-6874-430c-b4c1-cad6c848818e.gif width="600"></p>
</details>

<details>
  <summary><b>Code Generation</b></summary>

  Xircuits generates executable python scripts from the canvas. As they're very customizable, you can perform DevOps automation like actions. Consider this Xircuits template which trains an mnist classifier.
  
  ![hyperpara-codegen](https://user-images.githubusercontent.com/68586800/165815661-2b6e17e8-ed1d-4950-97b1-658d2bd14410.gif)

  You can run the code generated python script in Xircuits, but you can also take the same script to train 3 types of models in one go using bash script:

    TrainModel.py --epoch 5 --model "resnet50"
    TrainModel.py --epoch 5 --model "vgg16"
    TrainModel.py --epoch 5 --model "mobilenet"

</details>

<details>
<summary><b>Famous Python Library Support</b></summary>
Xircuits is built on top of the shoulders of giants. Perform ML and DL using Tensorflow or Pytorch, accelerate your big data processing via Spark, or perform autoML using Pycaret. We're constantly updating our Xircuits library, so stay tuned for more!

Didn't find what you're looking for? Creating Xircuits components is very easy! If it's in python - it can be made into a component. Your creativity is the limit, create components that are easily extendable!

</details>

<details>
<summary><b>Effortless Collaboration</b></summary>
Created a cool Xircuits workflow? Just pass the .xircuits file to your fellow data scientist, they will be able to load your Xircuits canvas instantly.

![collab](https://user-images.githubusercontent.com/68586800/165814749-bd782c59-f4d1-4452-a668-48543006d69e.gif)

Created a cool component library? All your colleagues need to do is to drop your component library folder in theirs and they can immediately use your components.


</details>

And many more.

# Installation
You will need python 3.8+ to install Xircuits. We recommend installing in a virtual environment.

  ```
  $ pip install xircuits
  ```

You will also need to install the component library before using them. For example, if you would like to use the Pytorch components, install them by:

  ```
  $ xircuits install pytorch
  ```

For the list of available libraries, you can check [here]( https://github.com/XpressAI/xircuits/tree/master/xai_components). 

## Download Examples
```
$ xircuits examples
```
## Launch
```
$ xircuits
```


# Development
Creating workflows and components in Xircuits is easy. We've provided extensive guides for you in our [documentation](https://xircuits.io/). Here are a few quick links to get you started:


- **Tutorials**: [Your First Xircuits Worflow](https://xircuits.io/docs/main/tutorials/running-a-xircuits-workflow) | [Running a Xircuits Project Template](https://xircuits.io/docs/main/tutorials/running-a-xircuits-project-template)
- **Component Development**: [Creating a Xircuits Component](https://xircuits.io/docs/main/developer-guide/creating-a-xircuits-component) | [Creating a Xircuits Component Library](https://xircuits.io/docs/main/developer-guide/creating-a-xircuits-component-library)
- **Advanced**: [Xircuits Core Development](https://xircuits.io/docs/main/developer-guide/developing-xircuits-core-features)

# Use Cases

### GPT Agent Toolkit | BabyAGI
![BabyAGI demo](https://github.com/XpressAI/xai-gpt-agent-toolkit/blob/main/demo.gif?raw=true)

### Discord Bots
![DiscordCVBot](https://user-images.githubusercontent.com/68586800/232880388-0a999fa2-f9cf-40df-be51-73601afc8963.gif)

### PySpark
![spark submit](https://user-images.githubusercontent.com/68586800/156138662-f3181471-6433-49dd-a8c1-2f73eea14d11.png)

### AutoML
![automl](https://user-images.githubusercontent.com/68586800/165808829-74070074-b23b-4bb7-8a4e-d1ff30f5df72.gif)

### Anomaly Detection
![anomaly-detection](https://user-images.githubusercontent.com/68586800/161716353-87def49c-af93-4819-9455-687de0b283df.gif)

### NLP
![nlp](https://user-images.githubusercontent.com/68586800/161892702-fbe51b93-846d-410a-bb80-75255c1a9565.gif)

## Developers Discord
Have any questions? Feel free to chat with the devs at our [Discord](https://discord.com/invite/vgEg2ZtxCw)!
