diff --git a/README.md b/README.md index c579b6f..34eb638 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![chat](https://img.shields.io/badge/support-slack-01579b)](https://join.slack.com/t/onepanel-ce/shared_invite/zt-eyjnwec0-nLaHhjif9Y~gA05KuX6AUg) [![license](https://img.shields.io/github/license/onepanelio/core?color=01579b)](https://opensource.org/licenses/Apache-2.0) -Production scale vision AI platform with fully integrated components for model building, automated labeling, data processing and model training pipelines. +Production scale vision AI platform with fully integrated modules for model building, automated labeling, data processing, model training and hyperparameter tuning pipelines. @@ -32,9 +32,9 @@ Onepanel can be found on [LF AI Landscape](http://landscape.lfai.foundation/sele - Extend Onepanel with powerful REST APIs and SDKs to further automate your workflows. ## Online demo -We have created an [online demo environment](https://onepanel.typeform.com/to/kQfDX5Vf?product=github) so that you can quickly try Onepanel. +We have created an [online demo environment](https://onepanel.typeform.com/to/kQfDX5Vf?product=github) so that you can get a feel for some of Onepanel's features. -**Note:** This is a shared, read only demo environment that is reset every few hours. +**Note:** This is a shared, read only, demo environment that will be occasionally rebuilt. ## Quick start See [quick start guide](https://docs.onepanel.ai/docs/getting-started/quickstart) to get started with the platform of your choice. @@ -53,30 +53,19 @@ For help, questions, release announcements and contribution discussions, join us ## Contributing -Onepanel is modular and consists of the following repositories: - -[Backend](https://github.com/onepanelio/core/) (this repository) - Code base for backend (Go)\ -[Frontend](https://github.com/onepanelio/core-ui/) - Code base for frontend (Angular + TypeScript)\ -[CLI](https://github.com/onepanelio/cli/) - Code base for installation and management CLI (Go)\ -[Manifests](https://github.com/onepanelio/manifests/) - Kustomize manifests used by installation and management CLI (YAML)\ -[Python SDK](https://github.com/onepanelio/python-sdk/) - Python SDK code and documentation (Python)\ -[Templates](https://github.com/onepanelio/templates) - Various Workspace, Workflow, Task and Sidecar Templates\ -[Documentation](https://github.com/onepanelio/core-docs/) - The repository for documentation site\ -[API Documentation](https://github.com/onepanelio/core-api-docs/) - API documentation if you choose to use the API directly - -See `CONTRIBUTING.md` in each repository for development guidelines. Also, see [contribution guide](https://docs.onepanel.ai/docs/getting-started/contributing) for additional guidelines. +Onepanel is modular and consists of [multiple repositories](https://docs.onepanel.ai/docs/getting-started/contributing/#project-repositories). +See [contribution guide](https://docs.onepanel.ai/docs/getting-started/contributing) and `CONTRIBUTING.md` in each repository for additional contribution guidelines. ## Acknowledgments -Onepanel seamlessly integrates the following excellent open source projects. We are grateful for the support these communities provide and do our best to contribute back as much as possible. +Onepanel seamlessly integrates the following open source projects under the hood: -[Argo](https://github.com/argoproj/argo)\ -[CVAT](https://github.com/opencv/cvat)\ -[JupyterLab](https://github.com/jupyterlab/jupyterlab)\ -[NNI](https://github.com/microsoft/nni) +[Argo](https://github.com/argoproj/argo) | [CVAT](https://github.com/opencv/cvat) | [JupyterLab](https://github.com/jupyterlab/jupyterlab) | [NNI](https://github.com/microsoft/nni) + +We are grateful for the support these communities provide and do our best to contribute back as much as possible. ## License Onepanel is licensed under [Apache 2.0](https://github.com/onepanelio/core/blob/master/LICENSE). ## Need a managed solution? -Visit our [website](https://www.onepanel.io/) for more information about our managed offerings. +Visit our [website](https://www.onepanel.io/) for more information about our enterprise offering.