3b1b / 3b1b/videos

Some experience of how to start

Open
#112 3 comments 2 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
11.2k
Forks
2.1k
Avg merge
5h 49m
Merged PRs (30d)
3

Description

Hello everyone, learned from some issue of how to start a demo in this project, i want to share some expreience, feel free to commit any suggestions, thanks.

Suppose that you have install manimgl and all thing it needed, for M3 pro of Mac, its FFmpeg and MacTex, see [install](https://github.com/3b1b/manim/blob/master/README.md) for details. To run a scene, only two things needed to be done. We will use the file: _2024/transformers/network_flow.py as examples(i like the explanation of transformer from 3B1B so much), and it's applicable to any other files.
1. Firstly, you need to add the following three lines before from manim_imports_ext import *
```
import sys
sys.path.append(".")
sys.path.append("..")
```
now the beginning of this file looks like
```
import torch
import sys
sys.path.append(".")
sys.path.append("..")
from manim_imports_ext import *
from _2024.transformers.helpers import *
from _2024.transformers.embedding import *
```

2. Edit the file named custom_config.yml, i suppose that you have git cloned this repo, just run pwd to get your current directory, and change to string after removed_mirror_prefix to pwd's output, then commit the base line, after modification, the begin of custom_config.yml looks like:
```
directories:
mirror_module_path: True
removed_mirror_prefix: "/Users/name/code/python/manim/videos/"
# base: "/Users/grant/3Blue1Brown Dropbox/3Blue1Brown/"
subdirs:
```

Now just enter the following line to enjoy this elegant code:
```
manimgl _2024/transformers/network_flow.py HighLevelNetworkFlow
```

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue describes steps to run a specific scene from the _2024/transformers/network_flow.py file. First, check if the README already covers this setup. Then, verify the custom_config.yml file exists and understand its structure. The goal is to integrate these instructions into the project's documentation, likely in the README or a CONTRIBUTING guide.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.