{"id":27005684,"url":"https://github.com/relevanceai/workflows","last_synced_at":"2025-04-04T07:17:06.901Z","repository":{"id":36988266,"uuid":"464703664","full_name":"RelevanceAI/workflows","owner":"RelevanceAI","description":"Relevance AI Workflows","archived":false,"fork":false,"pushed_at":"2022-11-24T23:00:30.000Z","size":7232,"stargazers_count":1,"open_issues_count":3,"forks_count":2,"subscribers_count":3,"default_branch":"development","last_synced_at":"2023-03-09T20:16:42.386Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RelevanceAI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-01T01:34:06.000Z","updated_at":"2022-03-04T01:43:05.000Z","dependencies_parsed_at":"2023-01-17T12:01:16.824Z","dependency_job_id":null,"html_url":"https://github.com/RelevanceAI/workflows","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RelevanceAI%2Fworkflows","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RelevanceAI%2Fworkflows/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RelevanceAI%2Fworkflows/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RelevanceAI%2Fworkflows/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RelevanceAI","download_url":"https://codeload.github.com/RelevanceAI/workflows/tar.gz/refs/heads/development","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247135126,"owners_count":20889421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-04T07:17:05.412Z","updated_at":"2025-04-04T07:17:06.892Z","avatar_url":"https://github.com/RelevanceAI.png","language":"Jupyter Notebook","readme":"![Github Banner](assets/github_banner.png)\r\n\r\n[![Documentation Status](https://readthedocs.org/projects/relevanceai/badge/?version=latest)](https://relevanceai.readthedocs.io/en/latest/?badge=latest)\r\n[![License](https://img.shields.io/pypi/l/relevanceai)](https://img.shields.io/pypi/l/relevanceai)\r\n\r\n[Join our slack channel!](https://join.slack.com/t/relevance-ai/shared_invite/zt-11fo8oush-dHPd57wamhoQ7J5arNv1mg)\r\n\r\n**Run Our Colab Notebook And Get Started In Less Than 10 Lines Of Code!**\r\n\r\n[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://hubs.ly/Q014Qbs10)\r\n\r\nFor guides and tutorials on how to use this package, visit https://docs.relevance.ai/docs.\r\n\r\n## 🔥 Workflows by Relevance AI\r\n\r\n![Workflows](assets/workflows.png)\r\n\r\nThis is a home for all of RelevanceAI's workflows as seen in the [dashboard](https://cloud.relevance.ai/). Sign up and getting started [here](https://cloud.relevance.ai/)!\r\n\r\n\r\nWorkflows provide users with a guide on how to run relevant code in Relevance AI.\r\nIt provides a guided interface through Relevance AI Features.\r\n\r\nSome of these features include:\r\n\r\n- Clustering\r\n- Dimensionality Reduction\r\n- Labelling/Tagging\r\n- Launching Projectors\r\n\r\n# How to add a workflow\r\n\r\nHow to add a workflow\r\n\r\n1) Add a subfolder and move notebook there and push the notebook\r\n2) Modify scripts/manual_add_to_db.py and add a new document in the `DOCS` variable and commit/push the script. Make sure to see what the other documents are doing and copy that structure else things may error!\r\n3) Create PR\r\n\r\n## 🔥 Features\r\n\r\n- Fast vector search with free dashboard to preview and visualise results\r\n- Vector clustering with support for libraries like scikit-learn and easy built-in customisation\r\n- Store nested documents with support for multiple vectors and metadata in one object\r\n- Multi-vector search with filtering, facets, weighting\r\n- Hybrid search with support for weighting keyword matching and vector search\r\n... and more!\r\n\r\n\r\n## 🚧 Development\r\n\r\n## 🛠️  Requirements\r\n\r\n- [Python ^3.7.0](https://www.python.org/downloads/release/python-3713/)\r\n- [AWS CLI v2](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) - if you need to upload new workflows to prod\r\n\r\n\r\n### Getting Started\r\nTo get started with development, install the dev dependencies\r\n\r\n```zsh\r\n❯ make install\r\n```\r\n\r\n### Uploading workflows\r\n\r\nMake sure your AWS SSO profile and creds configured in [`~/.aws/config`](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html).\r\n\r\nInstall [`yawsso`](https://github.com/victorskl/yawsso) or similar to sync API creds w/ SSO profile needed for CDK.\r\nSet the `AWS_PROFILE` env var to bypass having to specify `--profile` on every AWS CLI call.\r\n\r\n```zsh\r\n❯ ENVIRONMENT=development AWS_PROFILE=Relevance-AI.WorkflowsAdminAccess make upload\r\n```\r\n\r\n### Testing\r\n\r\n\r\nThen run testing using:\r\n\r\n\u003e Don't forget to set your test credentials!\r\n\r\n```zsh\r\nexport TEST_ACTIVATION_TOKEN=\u003cYOUR_ACTIVATION_TOKEN\u003e\r\n\r\n## For testing core workflows\r\nexport WORKFLOW_TOKEN_CLUSTER_YOUR_DATA_WITH_RELEVANCE_AI=\u003cDASHBOARD_BASE64_TOKEN_FROM_CLUSTER_WORKFLOW\u003e\r\nexport WORKFLOW_TOKEN_VECTORIZE_YOUR_DATA_WITH_RELEVANCE_AI=\u003cDASHBOARD_BASE64_TOKEN_FROM_VECTORIZE_WORKFLOW\u003e\r\nexport WORKFLOW_TOKEN_REDUCE_THE_DIMENSIONS_OF_YOUR_DATA_WITH_RELEVANCE_AI=\u003cDASHBOARD_BASE64_TOKEN_FROM_DR_WORKFLOW\u003e\r\nexport WORKFLOW_TOKEN_CORE_SUBCLUSTERING\u003cDASHBOARD_BASE64_TOKEN_FROM_SUBCLUSTERING_WORKFLOW\u003e\r\n```\r\n\r\nRun test script\r\n\r\n- tests all notebooks in `workflows`\r\n- outputs error `notebook_error.log`\r\n\r\n\r\n```zsh\r\n❯ python scripts/test_notebooks.py\r\n\r\n## Testing indiv notebook\r\n❯ python scripts/test_notebooks.py --notebooks subclustering/core_subclustering.ipynb\r\n```\r\n\r\n\r\n## More Helpful Commands\r\n\r\n```zsh\r\n❯ make help\r\nAvailable rules:\r\n\r\nclean               Delete all compiled Python files\r\ninstall             Install dependencies\r\nlint                Lint using flake8\r\ntest                Test dependencies\r\nupdate              Update dependencies\r\nupload              Upload notebooks to S3 and update ds\r\n```\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelevanceai%2Fworkflows","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frelevanceai%2Fworkflows","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelevanceai%2Fworkflows/lists"}