Skip to content

Commit 52484a0

Browse files
authored
Update config.md
1 parent be12a37 commit 52484a0

File tree

1 file changed

+60
-5
lines changed

1 file changed

+60
-5
lines changed

Version4/config.md

Lines changed: 60 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,26 @@ Works the same as batch_size above.
9696

9797
> You can use batch_size for setting defaults, then only one batch_size_xx for a specific gpu.
9898
99+
## workgroup_size
100+
(*since 4.0.99*)
101+
*Advanced setting*
102+
103+
Example: `workgroup_size = 512`
104+
105+
Default is 0, means auto detect.
106+
107+
Force a specific workgroup size for *all* the gpus.
108+
**Has to be a multiple of 32**
109+
110+
With no param, or 0, the miner auto detects what he thinks is the best setting for each GPU.
111+
If you run with `-d`, it will display the auto detected workgroup size.
112+
The defaults should be ok for most GPU.
113+
You can try to enforce a higher size than what is auto detecte on some systems (like AMDs).
114+
*Beware:* setting too high a value **will** make your gpu crash.
115+
116+
99117
## excludePlatforms
118+
*Advanced setting*
100119

101120
Exemple: `excludePlatforms = ["First platform to exclude", "Second one"]`
102121

@@ -110,13 +129,15 @@ By using the param, the excluded GPU won't even be listed, and will be disabled.
110129
Matches over the start of the vendor string as listed by the miner.
111130

112131
## excludeVendors
132+
*Advanced setting*
113133

114134
Exemple: `excludeVendors = ["NVIDIA"]`
115135

116136
Exclude GPUS by vendor name.
117137
Matches over the start of the vendor string as listed by the miner.
118138

119139
## heavyFileName
140+
*Advanced setting*
120141

121142
Exemple: `heavyFileName = "/an/alternate/location/to/heavy3a.bin"`
122143

@@ -131,6 +152,15 @@ There will be little use of this, since the file, once written, will only be rea
131152
It's not being modified, it's not being accessed afterward.
132153

133154

155+
## restartAfter
156+
*Since 4.0.100*
157+
158+
Force an auto close of the miner after restart minutes.
159+
Miner should then be restarted by the control script (provided bismuth.sh / bismuth.bat)
160+
161+
To restart every 2 hours:
162+
`restartAfter = 120`
163+
134164
```
135165
#### This file needs an empty line at the end.
136166
#### Don't ask why, and don"t remove it or you'll get a syntax error.
@@ -142,23 +172,48 @@ It's not being modified, it's not being accessed afterward.
142172
Some params are also available via command line switches.
143173
The param from command line wil ltake over miner.cfg file.
144174

145-
## -n name
175+
## -a address
146176

147-
Force that worker name
177+
Force that bismuth address as mining address
148178

149-
`-a These_gpus_are_made_for_hashing`
179+
`-a my_own_bismuth_address`
180+
181+
## -d debug
182+
183+
Be more verbose and print out debug info.
184+
May be useful for tuning, deactivate on prod systems.
150185

151-
## -i intensities
186+
## -i intensity
152187

153188
Like intensities from the config file.
154189
For instance, to disable GPU#0 of a 4 GPUs rig:
155190

156191
`-i 0,100,100,100`
157192

193+
## -n name
194+
195+
Force that worker name
196+
197+
`-a These_gpus_are_made_for_hashing`
198+
158199
## -r restart
159200

160201
Force an auto close of the miner after restart minutes.
161202
Miner should then be restarted by the control script (provided bismuth.sh / bismuth.bat)
162203

163-
To restart every 2 hours:
204+
To restart every 2 hours:
164205
`-r 120`
206+
207+
## -s sequential
208+
*Advanced setting*
209+
210+
Force a sequential init of the GPUs intead of one gpu per thread.
211+
Only impacts the init.
212+
213+
Mainly used for debug/tuning, in addition to `-d`
214+
215+
216+
217+
218+
219+

0 commit comments

Comments
 (0)