diff --git a/README.md b/README.md index ff0f0a5c77c..9cab08e6868 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

Determined AI Logo

+

Determined AI Logo

Determined is an all-in-one deep learning platform, compatible with PyTorch and TensorFlow. @@ -20,7 +20,8 @@ It takes care of: The main components of Determined are the Python library, the command line interface (CLI), and the Web UI. ## Python Library -Use the Python library to make your existing PyTorch or Tensorflow code compatible with Determined. + +Use the Python library to make your existing PyTorch or Tensorflow code compatible with Determined. You can do this by organizing your code into one of the class-based APIs: @@ -57,8 +58,8 @@ det deploy local cluster-up det deploy aws up ``` - - Train your models: + ```bash det experiment create gpt.yaml . ``` @@ -80,17 +81,16 @@ searcher: smaller_is_better: true ``` - ## Web UI Use the Web UI to view loss curves, hyperparameter plots, code and configuration snapshots, model registries, cluster utilization, debugging logs, performance profiling reports, and more. ![Web UI](docs/assets/readme_images/webui.png) - # Installation To install the CLI: + ```bash pip install determined ``` @@ -107,31 +107,29 @@ For installation details, visit the the cluster deployment guide for your enviro # Documentation -* [Documentation](https://docs.determined.ai) -* [Quick Start Guide](https://docs.determined.ai/latest/getting-started.html) -* Tutorials: - * [PyTorch MNIST Tutorial](https://docs.determined.ai/latest/tutorials/pytorch-mnist-tutorial.html) - * [TensorFlow Keras MNIST Tutorial](https://docs.determined.ai/latest/tutorials/tf-mnist-tutorial.html) -* User Guides: - * [Core API](https://docs.determined.ai/latest/model-dev-guide/apis-howto/api-core-ug.html) - * [PyTorch API](https://docs.determined.ai/latest/model-dev-guide/apis-howto/api-pytorch-ug.html) - * [Keras API](https://docs.determined.ai/latest/model-dev-guide/apis-howto/api-keras-ug.html) - * [DeepSpeed API](https://docs.determined.ai/latest/model-dev-guide/apis-howto/deepspeed/overview.html) - +- [Documentation](https://docs.determined.ai) +- [Quick Start Guide](https://docs.determined.ai/latest/getting-started.html) +- Tutorials: + - [PyTorch MNIST Tutorial](https://docs.determined.ai/latest/tutorials/pytorch-mnist-tutorial.html) + - [TensorFlow Keras MNIST Tutorial](https://docs.determined.ai/latest/tutorials/tf-mnist-tutorial.html) +- User Guides: + - [Core API](https://docs.determined.ai/latest/model-dev-guide/apis-howto/api-core-ug.html) + - [PyTorch API](https://docs.determined.ai/latest/model-dev-guide/apis-howto/api-pytorch-ug.html) + - [Keras API](https://docs.determined.ai/latest/model-dev-guide/apis-howto/api-keras-ug.html) + - [DeepSpeed API](https://docs.determined.ai/latest/model-dev-guide/apis-howto/deepspeed/overview.html) # Community If you need help, want to file a bug report, or just want to keep up-to-date with the latest news about Determined, please join the Determined community! -* [Slack](https://determined-community.slack.com) is the best place to - ask questions about Determined and get support. [Click here to join our Slack]( - https://join.slack.com/t/determined-community/shared_invite/zt-1f4hj60z5-JMHb~wSr2xksLZVBN61g_Q). -* You can also follow us on [YouTube](https://www.youtube.com/@DeterminedAI) and [Twitter](https://www.twitter.com/DeterminedAI). -* You can also join the [community mailing list](https://groups.google.com/a/determined.ai/forum/#!forum/community) +- [Slack](https://determined-community.slack.com) is the best place to + ask questions about Determined and get support. [Click here to join our Slack](https://join.slack.com/t/determined-community/shared_invite/zt-1f4hj60z5-JMHb~wSr2xksLZVBN61g_Q). +- You can also follow us on [YouTube](https://www.youtube.com/@DeterminedAI) and [Twitter](https://www.twitter.com/DeterminedAI). +- You can also join the [community mailing list](https://groups.google.com/a/determined.ai/forum/#!forum/community) to ask questions about the project and receive announcements. -* To report a bug, [open an issue](https://github.com/determined-ai/determined/issues) on GitHub. -* To report a security issue, email [`security@determined.ai`](mailto:security@determined.ai). +- To report a bug, [open an issue](https://github.com/determined-ai/determined/issues) on GitHub. +- To report a security issue, email [`security@determined.ai`](mailto:security@determined.ai). # Contributing diff --git a/determined-logo.png b/determined-logo.png deleted file mode 100644 index 0baad157ee8..00000000000 Binary files a/determined-logo.png and /dev/null differ diff --git a/determined-logo.svg b/determined-logo.svg new file mode 100644 index 00000000000..8163db12ad4 --- /dev/null +++ b/determined-logo.svg @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + +