README.rst 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. FATE Client
  2. ===========
  3. Tools for interacting with FATE.
  4. quick start
  5. -----------
  6. 1. (optional) create virtual env
  7. .. code-block:: bash
  8. python -m venv venv
  9. source venv/bin/activate
  10. 2. install FATE Client
  11. .. code-block:: bash
  12. pip install fate-client
  13. Pipeline
  14. ========
  15. A high-level python API that allows user to design, start,
  16. and query FATE jobs in a sequential manner. For more information,
  17. please refer to this `guide <../../doc/api/fate_client/pipeline.md>`__
  18. Initial Configuration
  19. ---------------------
  20. 1. provide server ip/port information of deployed FATE-Flow
  21. .. code-block:: bash
  22. # provide real ip address and port info to initialize pipeline
  23. pipeline init --ip 127.0.0.1 --port 9380
  24. # optionally, set log directory of Pipeline
  25. cd /data/projects/fate/python/fate_client/pipeline
  26. pipeline init --ip 127.0.0.1 --port 9380 --log-directory ./logs
  27. FATE Flow Command Line Interface (CLI) v2
  28. =========================================
  29. A command line interface providing series of commands for user to design, start,
  30. and query FATE jobs. For more information,
  31. please refer to this `guide <https://github.com/FederatedAI/FATE-Flow/blob/main/doc/fate_flow_client.md>`__
  32. Initial Configuration
  33. ---------------------
  34. 1. Configure server information
  35. .. code-block:: bash
  36. # configure values in conf/service_conf.yaml
  37. flow init -c /data/projects/fate/conf/service_conf.yaml
  38. # alternatively, input real ip address and port info to initialize cli
  39. flow init --ip 127.0.0.1 --port 9380