Documentation for shared_parameters
- Dominant language
- C++
- Stars
- 3.4k
- Forks
- 701
- PR merge metrics
- No merged PRs in 30d
Description
The Python API includes config options for `shared_parameters` and `shared_params`, but these are not properly documented. The DyNet Python reference manual currently has uninformative descriptions like "Parameters: | shared_parameters (bool) – shared parameters".
I presume that this is a bool to allow parameters to be shared across processes. However, the documentation on multiprocessing (https://dynet.readthedocs.io/en/latest/multiprocessing.html) currently suggests that Python support is pending. What is the status of this? My impression from trying to use this is that setting `shared_parameters` to `True` allows the use of Python's built-in multiprocessing module with DyNet objects. I haven't encountered any problems so far, but I would appreciate hearing if there are any known limitations.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the Python reference manual entries for `shared_parameters` and `shared_params`, then compare them with the multiprocessing documentation at dynet.readthedocs.io/en/latest/multiprocessing.html. Verify the options' behavior, Python multiprocessing support, and known limitations before replacing the uninformative descriptions with accurate guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, machine-learning
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100