nexusml


Namenexusml JSON
Version 0.1.0b0 PyPI version JSON
download
home_pageNone
SummaryA multimodal AutoML platform for classification and regression tasks
upload_time2024-12-05 17:32:05
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT
keywords automl multimodal classification regression
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <img src="https://raw.githubusercontent.com/neuraptic/nexusml/main/assets/logo.svg" alt="Logo" height="200">
</p>

<p align="center">
  <a href="https://github.com/neuraptic/nexusml/actions/workflows/format-and-lint.yml">
    <img src="https://github.com/neuraptic/nexusml/actions/workflows/format-and-lint.yml/badge.svg" alt="Code Formatting & Linting">
  </a>
  <a href="https://github.com/neuraptic/nexusml/actions/workflows/publish-to-pypi.yml">
    <img src="https://github.com/neuraptic/nexusml/actions/workflows/publish-to-pypi.yml/badge.svg" alt="PyPI Publication">
  </a>
</p>

<br>

<!-- toc -->

- [Introduction](#introduction)
- [Requirements](#requirements)
- [Installation](#installation)
- [Multi-Tenancy and Subscriptions](#multi-tenancy-and-subscriptions)
- [Pending Refactor Note](#pending-refactor-note)
- [Additional Documentation](#additional-documentation)
- [Maintainers](#maintainers)
- [Acknowledgments](#acknowledgments)

## Introduction

NexusML is a multimodal AutoML platform for classification and regression tasks.

Please refer to [docs/what-is-nexusml.md](https://github.com/neuraptic/nexusml/blob/main/docs/what-is-nexusml.md) 
and [docs/concepts.md](https://github.com/neuraptic/nexusml/blob/main/docs/concepts.md) for an overview of NexusML 
and its key features.

## Requirements

- Python 3.10
- [Auth0](https://auth0.com/) configuration for user authentication
- [AWS S3](https://aws.amazon.com/s3/) configuration if you want to use S3 as the file storage backend

## Installation

You can install NexusML with pip:

```bash
pip install nexusml
```

## Multi-Tenancy and Subscriptions

NexusML is designed with multi-tenancy in mind, enabling multiple organizations (tenants) to use the platform 
independently within isolated workspaces. Each tenant has its own environment, where organization members can 
collaborate on tasks, manage data, and deploy AI models without affecting other tenants.

> ℹ️ Multi-tenancy requires [Auth0](https://auth0.com/) for user authentication. Please refer to 
> [docs/auth0.md](https://github.com/neuraptic/nexusml/blob/main/docs/auth0.md) for instructions on setting up Auth0 
> for NexusML.

NexusML allows you to create and customize subscription plans, adjusting quota limits (such as storage and compute 
resources) to meet the specific needs of different organizations.

> ℹ️ Billing and payment processing are not implemented. To use NexusML in a production environment, you will need to 
> integrate a billing and payment system such as [Stripe](https://stripe.com/). To do this, you will need to override 
> the `nexusml.api.jobs.periodic_jobs.bill()` function.

## Pending Refactor Note

The engine was originally designed as a standalone RESTful API, operating on a separate infrastructure from the main 
API. As a result, interactions between the engine and the main API rely heavily on JSON objects (Python dictionaries).

We are planning a comprehensive refactor to allow the engine to interact directly with database models. This change 
will streamline and simplify the integration between the engine and the main API.

## Additional Documentation

The [docs](https://github.com/neuraptic/nexusml/blob/main/docs) directory contains additional documentation:

- [architecture.md](https://github.com/neuraptic/nexusml/blob/main/docs/architecture.md): Describes the architecture 
  of NexusML.
- [auth0.md](https://github.com/neuraptic/nexusml/blob/main/docs/auth0.md): Describes the Auth0 configuration for 
  NexusML.
- [concepts.md](https://github.com/neuraptic/nexusml/blob/main/docs/concepts.md): Describes the concepts used in 
  NexusML.
- [quickstart.md](https://github.com/neuraptic/nexusml/blob/main/docs/quickstart.md): Provides a quick start guide for 
  NexusML.
- [states-and-statuses.md](https://github.com/neuraptic/nexusml/blob/main/docs/states-and-statuses.md): Describes 
  NexusML's states and statuses.
- [what-is-nexusml.md](https://github.com/neuraptic/nexusml/blob/main/docs/what-is-nexusml.md): Provides an overview 
  of NexusML.

## Maintainers

NexusML is maintained by the following individuals (in alphabetical order):

- Mikel Elkano Ilintxeta ([@melkilin](https://github.com/melkilin))
- Mikel Uriz Martin ([@MikelUriz](https://github.com/MikelUriz))

## Acknowledgments

We would like to recognize the valuable contributions of the following individuals (in alphabetical order):

- Enrique Hernández Calabrés ([@ehcalabres](https://github.com/ehcalabres))
- Leyre Ayllón Lafuente ([@layllon](https://github.com/layllon))
- Marco D'Alessandro ([@IoSonoMarco](https://github.com/IoSonoMarco))
- Miguel Ángel Álvarez Fernández ([@MigangalWork](https://github.com/MigangalWork))
- Miguel Pérez Martínez ([@MiguelPerezMartinez](https://github.com/MiguelPerezMartinez))

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nexusml",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "automl, multimodal, classification, regression",
    "author": null,
    "author_email": "Neuraptic AI <support@neuraptic.ai>",
    "download_url": "https://files.pythonhosted.org/packages/b8/70/e6bcbb32fee2af57385c5f4b2a5cce343191b9ee4ce3ec4d68e524b94352/nexusml-0.1.0b0.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img src=\"https://raw.githubusercontent.com/neuraptic/nexusml/main/assets/logo.svg\" alt=\"Logo\" height=\"200\">\n</p>\n\n<p align=\"center\">\n  <a href=\"https://github.com/neuraptic/nexusml/actions/workflows/format-and-lint.yml\">\n    <img src=\"https://github.com/neuraptic/nexusml/actions/workflows/format-and-lint.yml/badge.svg\" alt=\"Code Formatting & Linting\">\n  </a>\n  <a href=\"https://github.com/neuraptic/nexusml/actions/workflows/publish-to-pypi.yml\">\n    <img src=\"https://github.com/neuraptic/nexusml/actions/workflows/publish-to-pypi.yml/badge.svg\" alt=\"PyPI Publication\">\n  </a>\n</p>\n\n<br>\n\n<!-- toc -->\n\n- [Introduction](#introduction)\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Multi-Tenancy and Subscriptions](#multi-tenancy-and-subscriptions)\n- [Pending Refactor Note](#pending-refactor-note)\n- [Additional Documentation](#additional-documentation)\n- [Maintainers](#maintainers)\n- [Acknowledgments](#acknowledgments)\n\n## Introduction\n\nNexusML is a multimodal AutoML platform for classification and regression tasks.\n\nPlease refer to [docs/what-is-nexusml.md](https://github.com/neuraptic/nexusml/blob/main/docs/what-is-nexusml.md) \nand [docs/concepts.md](https://github.com/neuraptic/nexusml/blob/main/docs/concepts.md) for an overview of NexusML \nand its key features.\n\n## Requirements\n\n- Python 3.10\n- [Auth0](https://auth0.com/) configuration for user authentication\n- [AWS S3](https://aws.amazon.com/s3/) configuration if you want to use S3 as the file storage backend\n\n## Installation\n\nYou can install NexusML with pip:\n\n```bash\npip install nexusml\n```\n\n## Multi-Tenancy and Subscriptions\n\nNexusML is designed with multi-tenancy in mind, enabling multiple organizations (tenants) to use the platform \nindependently within isolated workspaces. Each tenant has its own environment, where organization members can \ncollaborate on tasks, manage data, and deploy AI models without affecting other tenants.\n\n> \u2139\ufe0f Multi-tenancy requires [Auth0](https://auth0.com/) for user authentication. Please refer to \n> [docs/auth0.md](https://github.com/neuraptic/nexusml/blob/main/docs/auth0.md) for instructions on setting up Auth0 \n> for NexusML.\n\nNexusML allows you to create and customize subscription plans, adjusting quota limits (such as storage and compute \nresources) to meet the specific needs of different organizations.\n\n> \u2139\ufe0f Billing and payment processing are not implemented. To use NexusML in a production environment, you will need to \n> integrate a billing and payment system such as [Stripe](https://stripe.com/). To do this, you will need to override \n> the `nexusml.api.jobs.periodic_jobs.bill()` function.\n\n## Pending Refactor Note\n\nThe engine was originally designed as a standalone RESTful API, operating on a separate infrastructure from the main \nAPI. As a result, interactions between the engine and the main API rely heavily on JSON objects (Python dictionaries).\n\nWe are planning a comprehensive refactor to allow the engine to interact directly with database models. This change \nwill streamline and simplify the integration between the engine and the main API.\n\n## Additional Documentation\n\nThe [docs](https://github.com/neuraptic/nexusml/blob/main/docs) directory contains additional documentation:\n\n- [architecture.md](https://github.com/neuraptic/nexusml/blob/main/docs/architecture.md): Describes the architecture \n  of NexusML.\n- [auth0.md](https://github.com/neuraptic/nexusml/blob/main/docs/auth0.md): Describes the Auth0 configuration for \n  NexusML.\n- [concepts.md](https://github.com/neuraptic/nexusml/blob/main/docs/concepts.md): Describes the concepts used in \n  NexusML.\n- [quickstart.md](https://github.com/neuraptic/nexusml/blob/main/docs/quickstart.md): Provides a quick start guide for \n  NexusML.\n- [states-and-statuses.md](https://github.com/neuraptic/nexusml/blob/main/docs/states-and-statuses.md): Describes \n  NexusML's states and statuses.\n- [what-is-nexusml.md](https://github.com/neuraptic/nexusml/blob/main/docs/what-is-nexusml.md): Provides an overview \n  of NexusML.\n\n## Maintainers\n\nNexusML is maintained by the following individuals (in alphabetical order):\n\n- Mikel Elkano Ilintxeta ([@melkilin](https://github.com/melkilin))\n- Mikel Uriz Martin ([@MikelUriz](https://github.com/MikelUriz))\n\n## Acknowledgments\n\nWe would like to recognize the valuable contributions of the following individuals (in alphabetical order):\n\n- Enrique Hern\u00e1ndez Calabr\u00e9s ([@ehcalabres](https://github.com/ehcalabres))\n- Leyre Ayll\u00f3n Lafuente ([@layllon](https://github.com/layllon))\n- Marco D'Alessandro ([@IoSonoMarco](https://github.com/IoSonoMarco))\n- Miguel \u00c1ngel \u00c1lvarez Fern\u00e1ndez ([@MigangalWork](https://github.com/MigangalWork))\n- Miguel P\u00e9rez Mart\u00ednez ([@MiguelPerezMartinez](https://github.com/MiguelPerezMartinez))\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A multimodal AutoML platform for classification and regression tasks",
    "version": "0.1.0b0",
    "project_urls": {
        "Homepage": "https://github.com/neuraptic/nexusml"
    },
    "split_keywords": [
        "automl",
        " multimodal",
        " classification",
        " regression"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e20e3db0c76558f9ff5f5eaac491f808bc7325152a6d9fc5df0599db9c4b1c10",
                "md5": "1db2d5101a322905b3740234ff4ea61c",
                "sha256": "881ccb418b3a91265d55b9b462870b58470ba71bd6724aad2c35fd15c26922c1"
            },
            "downloads": -1,
            "filename": "nexusml-0.1.0b0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1db2d5101a322905b3740234ff4ea61c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 421879,
            "upload_time": "2024-12-05T17:32:03",
            "upload_time_iso_8601": "2024-12-05T17:32:03.053607Z",
            "url": "https://files.pythonhosted.org/packages/e2/0e/3db0c76558f9ff5f5eaac491f808bc7325152a6d9fc5df0599db9c4b1c10/nexusml-0.1.0b0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b870e6bcbb32fee2af57385c5f4b2a5cce343191b9ee4ce3ec4d68e524b94352",
                "md5": "1f4e3a8c79055408f751fdfb4fae171b",
                "sha256": "629934a8ab3b7fd3404d5a502b641fc12cf5acf903233a58966c673db405099a"
            },
            "downloads": -1,
            "filename": "nexusml-0.1.0b0.tar.gz",
            "has_sig": false,
            "md5_digest": "1f4e3a8c79055408f751fdfb4fae171b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 358318,
            "upload_time": "2024-12-05T17:32:05",
            "upload_time_iso_8601": "2024-12-05T17:32:05.370798Z",
            "url": "https://files.pythonhosted.org/packages/b8/70/e6bcbb32fee2af57385c5f4b2a5cce343191b9ee4ce3ec4d68e524b94352/nexusml-0.1.0b0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-05 17:32:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "neuraptic",
    "github_project": "nexusml",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "nexusml"
}
        
Elapsed time: 0.42883s