Chouffe opened a new issue #14704: [clojure][documentation] improve docstrings URL: https://github.com/apache/incubator-mxnet/issues/14704 Some docstrings can still be improved for better user experience. Adding parameter descriptions and examples in docstrings. Example: ```clojure (defn init-optimizer "Install and initialize optimizers. `mod`: Module `opts-map` { `kvstore`: string - Default is \"local\" `optimizer`: Optimizer - Default is `sgd` `reset-optimizer`: boolean - Default is `true` Indicating whether we should set `rescaleGrad` & `idx2name` for optimizer according to executorGroup. `force-init`: boolean - Default is `false` Indicating whether we should force re-initializing the optimizer in the case an optimizer is already installed. Ex: (init-optimizer {:optimizer (optimizer/sgd {:learning-rate 0.1})})" ([mod {:keys [kvstore optimizer reset-optimizer force-init] :as opts :or {kvstore "local" optimizer (optimizer/sgd) reset-optimizer true force-init false}}] (util/validate! ::init-optimizer-opts opts "Invalid init-optimizer options") (doto mod (.initOptimizer kvstore optimizer reset-optimizer force-init))) ([mod] (init-optimizer mod {}))) ``` Below is a list of namespaces that still need to be improved: - [ ] `callback.clj` - [ ] `context.clj` - [ ] `executor.clj` - [ ] `eval_metric.clj` - [x] `image.clj` - [ ] `infer.clj` - [ ] `initializer.clj` - [ ] `io.clj` - [ ] `module.clj` - [ ] `ndarray.clj` - [ ] `optimizer.clj` - [ ] `profile.clj` - [x] `random.clj` - [ ] `symbol.clj` - [ ] `util.clj` - [ ] `visualization.clj`
---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
