@@ -58,6 +58,9 @@ public class DecisionModel {
5858 * It's an equivalent of DecisionModel(modelName, defaultTrackURL, defaultTrackApiKey)
5959 * We suggest to have the defaultTrackURL/defaultTrackApiKey set on startup before creating
6060 * any DecisionModel instances.
61+ * @param modelName Length of modelName must be in range [1, 64]; Only alphanumeric
62+ * characters([a-zA-Z0-9]), '-', '.' and '_' are allowed in the modelName
63+ * and the first character must be an alphanumeric one.
6164 * */
6265 public DecisionModel (String modelName ) {
6366 this (modelName , sDefaultTrackURL , sDefaultTrackApiKey );
@@ -66,7 +69,7 @@ public DecisionModel(String modelName) {
6669 /**
6770 * @param modelName Length of modelName must be in range [1, 64]; Only alphanumeric
6871 * characters([a-zA-Z0-9]), '-', '.' and '_' are allowed in the modelName
69- * and the first character must be an alphanumeric one;
72+ * and the first character must be an alphanumeric one.
7073 * @param trackURL url for tracking decisions. If trackURL is null, no decisions would be
7174 * tracked. If trackURL is not a valid URL, an exception would be thrown.
7275 * @param trackApiKey will be attached to the header fields of all the post request for tracking
@@ -137,6 +140,12 @@ public void loadAsync(URL modelUrl) {
137140 * may cause leaks. Before we add a cancel method to allow aborting downloading tasks, you may
138141 * have to call loadAsync() in something like a Singleton class.
139142 * @deprecated The callback method signature will likely have to change for multiple URLs
143+ * @param modelUrl A url that can be a local file path, a remote http url that points to a
144+ * model file, or a bundled asset. Urls that ends with '.gz' are considered gzip
145+ * compressed, and will be handled appropriately. Bundled model asset urls
146+ * appears a bit different. Suppose that you have a bundled model file in folder
147+ * "assets/models/my_model.xgb.gz", then modelUrl should be
148+ * new URL("file:///android_asset/models/my_model.xgb").
140149 * */
141150 @ Deprecated
142151 public void loadAsync (URL modelUrl , LoadListener listener ) {
0 commit comments