Skip to content

Commit

Permalink
chore: replace readme logo with svg [WEB-314]
Browse files Browse the repository at this point in the history
  • Loading branch information
EmilyBonar committed Dec 7, 2023
1 parent 816d203 commit 13086b3
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 23 deletions.
44 changes: 21 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center"><img src="determined-logo.png" alt="Determined AI Logo"></p>
<p align="center"><img width="400" src="determined-logo.svg" alt="Determined AI Logo"></p>

Determined is an all-in-one deep learning platform, compatible with PyTorch and TensorFlow.

Expand All @@ -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:

Expand Down Expand Up @@ -57,8 +58,8 @@ det deploy local cluster-up
det deploy aws up
```


- Train your models:

```bash
det experiment create gpt.yaml .
```
Expand All @@ -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
```
Expand All @@ -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 [`[email protected]`](mailto:[email protected]).
- To report a bug, [open an issue](https://github.com/determined-ai/determined/issues) on GitHub.
- To report a security issue, email [`[email protected]`](mailto:[email protected]).

# Contributing

Expand Down
Binary file removed determined-logo.png
Binary file not shown.
22 changes: 22 additions & 0 deletions determined-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 13086b3

Please sign in to comment.