Skip to content

Commit

Permalink
Change broken user guide link to quick start
Browse files Browse the repository at this point in the history
The link to the user guide under "Getting Started" in the README.md now
404s, so I've replaced it with a link to the quick start which looks
like the closest replacement.

Whilst at it, add syntax highlighting to a code block in the README.md
which was missing it.
  • Loading branch information
srstevenson committed Dec 3, 2024
1 parent 93af28a commit 80098ab
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

<h4><p align='center'>
<a href="https://www.mosaicml.com">[Website]</a>
- <a href="https://streaming.docs.mosaicml.com/en/latest/getting_started/user_guide.html">[Getting Started]</a>
- <a href="https://docs.mosaicml.com/projects/streaming/en/latest/getting_started/quick_start.html">[Quick Start]</a>
- <a href="https://streaming.docs.mosaicml.com/">[Docs]
- <a href="https://www.databricks.com/company/careers/open-positions?department=Mosaic%20AI&location=all">[We're Hiring!]</a>
</p></h4>
Expand Down Expand Up @@ -195,7 +195,8 @@ dataset = StreamingInsideWebVid(local=local, remote=remote, shuffle=True)

Easily experiment with dataset mixtures with [`Stream`](https://docs.mosaicml.com/projects/streaming/en/latest/api_reference/generated/streaming.Stream.html#stream). Dataset sampling can be controlled in relative (proportion) or absolute (repeat or samples terms). During streaming, the different datasets are streamed, shuffled, and mixed seamlessly just-in-time.

```
<!--pytest.mark.skip-->
```python
# mix C4, github code, and internal datasets
streams = [
Stream(remote='s3://datasets/c4', proportion=0.4),
Expand Down

0 comments on commit 80098ab

Please sign in to comment.