Skip to content

Commit

Permalink
start: faster to value and... (#384)
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel authored Mar 8, 2023
1 parent 372db11 commit ad9c59b
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 37 deletions.
28 changes: 23 additions & 5 deletions content/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# CML Documentation

[Continuous Machine Learning (CML)](https://cml.dev) is an open-source library
for implementing continuous integration & delivery (CI/CD) in machine learning
projects. Use it to automate parts of your development workflow, including model
training and evaluation, comparing ML experiments across your project history,
and monitoring changing datasets.
[Continuous Machine Learning (CML)](/) is an open-source tool for implementing
continuous integration & delivery (CI/CD) in machine learning projects. Use it
to automate parts of your development workflow, including model training and
evaluation, comparing ML experiments across your project history, and monitoring
changing datasets.

<cards>

Expand Down Expand Up @@ -35,3 +35,21 @@ us a ⭐ if you like the project!

✅ Contribute to CML [on GitHub](https://github.com/iterative/cml) or help us
improve this [documentation](https://github.com/iterative/cml.dev) 🙏.

## CML principles

- **[GitFlow] for data science.** Use GitLab or GitHub to manage ML experiments,
track who trained ML models, or modified data and when. Codify data and models
with [DVC](/doc/cml-with-dvc) instead of pushing to a Git repo.

- **Auto reports for ML experiments.** Auto-generate reports with metrics and
plots in each Git Pull Request. Rigorous engineering practices help your team
make informed, data-driven decisions.

- **No additional services.** Build your own ML platform using just GitHub or
GitLab and your [favorite cloud providers]: AWS, Azure, GCP, or Kubernetes. No
databases, services or complex setup needed

[gitflow]: https://nvie.com/posts/a-successful-git-branching-model
[favorite cloud providers]:
/doc/self-hosted-runners#cloud-compute-resource-credentials
57 changes: 25 additions & 32 deletions content/docs/start/index.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,29 @@
# CML is Continuous Machine Learning

[Continuous Machine Learning (CML)](https://cml.dev) is an open-source library
for implementing continuous integration & delivery (CI/CD) in machine learning
projects. Use it to automate parts of your development workflow, including model
training and evaluation, comparing ML experiments across your project history,
and monitoring changing datasets.

![](/img/cml_neural_transfer.png) _On every pull request, CML helps you
automatically train and evaluate models, then generates a visual report with
results and metrics. Above, an example report for a
[neural style transfer model](https://rb.gy/ub5idx)._

We built CML with these principles in mind:

- **[GitFlow](https://nvie.com/posts/a-successful-git-branching-model) for data
science.** Use GitLab or GitHub to manage ML experiments, track who trained ML
models or modified data and when. Codify data and models with
[DVC](/doc/cml-with-dvc) instead of pushing to a Git repo.
- **Auto reports for ML experiments.** Auto-generate reports with metrics and
plots in each Git Pull Request. Rigorous engineering practices help your team
make informed, data-driven decisions.
- **No additional services.** Build your own ML platform using just GitHub or
GitLab and your
[favorite cloud services](/doc/self-hosted-runners#cloud-compute-resource-credentials):
AWS, Azure, GCP, or Kubernetes. No databases, services or complex setup
needed.
# Get Started with CML

CML helps you automatically train and evaluate machine learning models right in
your pull/merge requests. It can also embed reports from the results, including
plots and metrics.

![](/img/cml_neural_transfer.png) _Report for a [neural style transfer model]._

**Pick one of the supported platforms to continue: [GitHub](/doc/start/github) /
[GitLab](/doc/start/github) / [Bitbucket](/doc/start/github)**

---

Feel free to also check out our [YouTube video series] for hands-on MLOps
tutorials using CML!

https://www.youtube.com/watch?v=9BgIDqAzfuA&list=PL7WG7YrwYcnDBDuCkFbcyjnZQrdskFsBz&index=1&ab_channel=DVCorg

[youtube video series]:
https://www.youtube.com/playlist?list=PL7WG7YrwYcnDBDuCkFbcyjnZQrdskFsBz

<admon type="info">

_Need help? Just want to chat about continuous integration for ML?
[Visit our Discord channel!](/chat)_
[Visit our Discord channel!](https://cml.dev/chat)_

🌟 Check out our
[YouTube video series](https://www.youtube.com/playlist?list=PL7WG7YrwYcnDBDuCkFbcyjnZQrdskFsBz)
for hands-on MLOps tutorials using CML! 🌟
</admon>

https://youtu.be/9BgIDqAzfuA
[neural style transfer model]: https://github.com/iterative/cml_cloud_case

0 comments on commit ad9c59b

Please sign in to comment.